Skip to content

Files

Latest commit

 

History

History
6391 lines (4050 loc) · 305 KB
·

cloudfunctionsFunction.python.md

File metadata and controls

6391 lines (4050 loc) · 305 KB
·

cloudfunctionsFunction Submodule

Constructs

CloudfunctionsFunction

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function google_cloudfunctions_function}.

Initializers

from cdktf_cdktf_provider_google import cloudfunctions_function

cloudfunctionsFunction.CloudfunctionsFunction(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  name: str,
  runtime: str,
  available_memory_mb: typing.Union[int, float] = None,
  build_environment_variables: typing.Mapping[str] = None,
  build_service_account: str = None,
  build_worker_pool: str = None,
  description: str = None,
  docker_registry: str = None,
  docker_repository: str = None,
  entry_point: str = None,
  environment_variables: typing.Mapping[str] = None,
  event_trigger: CloudfunctionsFunctionEventTrigger = None,
  https_trigger_security_level: str = None,
  https_trigger_url: str = None,
  id: str = None,
  ingress_settings: str = None,
  kms_key_name: str = None,
  labels: typing.Mapping[str] = None,
  max_instances: typing.Union[int, float] = None,
  min_instances: typing.Union[int, float] = None,
  project: str = None,
  region: str = None,
  secret_environment_variables: typing.Union[IResolvable, typing.List[CloudfunctionsFunctionSecretEnvironmentVariables]] = None,
  secret_volumes: typing.Union[IResolvable, typing.List[CloudfunctionsFunctionSecretVolumes]] = None,
  service_account_email: str = None,
  source_archive_bucket: str = None,
  source_archive_object: str = None,
  source_repository: CloudfunctionsFunctionSourceRepository = None,
  timeout: typing.Union[int, float] = None,
  timeouts: CloudfunctionsFunctionTimeouts = None,
  trigger_http: typing.Union[bool, IResolvable] = None,
  vpc_connector: str = None,
  vpc_connector_egress_settings: str = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
name str A user-defined name of the function. Function names must be unique globally.
runtime str The runtime in which the function is going to run. Eg. "nodejs20", "python37", "go111".
available_memory_mb typing.Union[int, float] Memory (in MB), available to the function. Default value is 256. Possible values include 128, 256, 512, 1024, etc.
build_environment_variables typing.Mapping[str] A set of key/value environment variable pairs available during build time.
build_service_account str The fully-qualified name of the service account to be used for the build step of deploying this function.
build_worker_pool str Name of the Cloud Build Custom Worker Pool that should be used to build the function.
description str Description of the function.
docker_registry str Docker Registry to use for storing the function's Docker images. Allowed values are ARTIFACT_REGISTRY (default) and CONTAINER_REGISTRY.
docker_repository str User managed repository created in Artifact Registry optionally with a customer managed encryption key.
entry_point str Name of the function that will be executed when the Google Cloud Function is triggered.
environment_variables typing.Mapping[str] A set of key/value environment variable pairs to assign to the function.
event_trigger CloudfunctionsFunctionEventTrigger event_trigger block.
https_trigger_security_level str The security level for the function. Defaults to SECURE_OPTIONAL. Valid only if trigger_http is used.
https_trigger_url str URL which triggers function execution. Returned only if trigger_http is used.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#id CloudfunctionsFunction#id}.
ingress_settings str String value that controls what traffic can reach the function.
kms_key_name str Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function resources.
labels typing.Mapping[str] A set of key/value label pairs to assign to the function. Label keys must follow the requirements at https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements.
max_instances typing.Union[int, float] The limit on the maximum number of function instances that may coexist at a given time.
min_instances typing.Union[int, float] The limit on the minimum number of function instances that may coexist at a given time.
project str Project of the function. If it is not provided, the provider project is used.
region str Region of function. If it is not provided, the provider region is used.
secret_environment_variables typing.Union[cdktf.IResolvable, typing.List[CloudfunctionsFunctionSecretEnvironmentVariables]] secret_environment_variables block.
secret_volumes typing.Union[cdktf.IResolvable, typing.List[CloudfunctionsFunctionSecretVolumes]] secret_volumes block.
service_account_email str If provided, the self-provided service account to run the function with.
source_archive_bucket str The GCS bucket containing the zip archive which contains the function.
source_archive_object str The source archive object (file) in archive bucket.
source_repository CloudfunctionsFunctionSourceRepository source_repository block.
timeout typing.Union[int, float] Timeout (in seconds) for the function. Default value is 60 seconds. Cannot be more than 540 seconds.
timeouts CloudfunctionsFunctionTimeouts timeouts block.
trigger_http typing.Union[bool, cdktf.IResolvable] Boolean variable.
vpc_connector str The VPC Network Connector that this cloud function can connect to.
vpc_connector_egress_settings str The egress settings for the connector, controlling what traffic is diverted through it.

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope


connectionOptional
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

countOptional
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

depends_onOptional
  • Type: typing.List[cdktf.ITerraformDependable]

for_eachOptional
  • Type: cdktf.ITerraformIterator

lifecycleOptional
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
  • Type: cdktf.TerraformProvider

provisionersOptional
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

nameRequired
  • Type: str

A user-defined name of the function. Function names must be unique globally.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#name CloudfunctionsFunction#name}


runtimeRequired
  • Type: str

The runtime in which the function is going to run. Eg. "nodejs20", "python37", "go111".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#runtime CloudfunctionsFunction#runtime}


available_memory_mbOptional
  • Type: typing.Union[int, float]

Memory (in MB), available to the function. Default value is 256. Possible values include 128, 256, 512, 1024, etc.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#available_memory_mb CloudfunctionsFunction#available_memory_mb}


build_environment_variablesOptional
  • Type: typing.Mapping[str]

A set of key/value environment variable pairs available during build time.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#build_environment_variables CloudfunctionsFunction#build_environment_variables}


build_service_accountOptional
  • Type: str

The fully-qualified name of the service account to be used for the build step of deploying this function.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#build_service_account CloudfunctionsFunction#build_service_account}


build_worker_poolOptional
  • Type: str

Name of the Cloud Build Custom Worker Pool that should be used to build the function.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#build_worker_pool CloudfunctionsFunction#build_worker_pool}


descriptionOptional
  • Type: str

Description of the function.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#description CloudfunctionsFunction#description}


docker_registryOptional
  • Type: str

Docker Registry to use for storing the function's Docker images. Allowed values are ARTIFACT_REGISTRY (default) and CONTAINER_REGISTRY.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#docker_registry CloudfunctionsFunction#docker_registry}


docker_repositoryOptional
  • Type: str

User managed repository created in Artifact Registry optionally with a customer managed encryption key.

If specified, deployments will use Artifact Registry for storing images built with Cloud Build.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#docker_repository CloudfunctionsFunction#docker_repository}


entry_pointOptional
  • Type: str

Name of the function that will be executed when the Google Cloud Function is triggered.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#entry_point CloudfunctionsFunction#entry_point}


environment_variablesOptional
  • Type: typing.Mapping[str]

A set of key/value environment variable pairs to assign to the function.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#environment_variables CloudfunctionsFunction#environment_variables}


event_triggerOptional

event_trigger block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#event_trigger CloudfunctionsFunction#event_trigger}


https_trigger_security_levelOptional
  • Type: str

The security level for the function. Defaults to SECURE_OPTIONAL. Valid only if trigger_http is used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#https_trigger_security_level CloudfunctionsFunction#https_trigger_security_level}


https_trigger_urlOptional
  • Type: str

URL which triggers function execution. Returned only if trigger_http is used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#https_trigger_url CloudfunctionsFunction#https_trigger_url}


idOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#id CloudfunctionsFunction#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.


ingress_settingsOptional
  • Type: str

String value that controls what traffic can reach the function.

Allowed values are ALLOW_ALL and ALLOW_INTERNAL_ONLY. Changes to this field will recreate the cloud function.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#ingress_settings CloudfunctionsFunction#ingress_settings}


kms_key_nameOptional
  • Type: str

Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function resources.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#kms_key_name CloudfunctionsFunction#kms_key_name}


labelsOptional
  • Type: typing.Mapping[str]

A set of key/value label pairs to assign to the function. Label keys must follow the requirements at https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#labels CloudfunctionsFunction#labels}


max_instancesOptional
  • Type: typing.Union[int, float]

The limit on the maximum number of function instances that may coexist at a given time.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#max_instances CloudfunctionsFunction#max_instances}


min_instancesOptional
  • Type: typing.Union[int, float]

The limit on the minimum number of function instances that may coexist at a given time.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#min_instances CloudfunctionsFunction#min_instances}


projectOptional
  • Type: str

Project of the function. If it is not provided, the provider project is used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#project CloudfunctionsFunction#project}


regionOptional
  • Type: str

Region of function. If it is not provided, the provider region is used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#region CloudfunctionsFunction#region}


secret_environment_variablesOptional

secret_environment_variables block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#secret_environment_variables CloudfunctionsFunction#secret_environment_variables}


secret_volumesOptional

secret_volumes block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#secret_volumes CloudfunctionsFunction#secret_volumes}


service_account_emailOptional
  • Type: str

If provided, the self-provided service account to run the function with.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#service_account_email CloudfunctionsFunction#service_account_email}


source_archive_bucketOptional
  • Type: str

The GCS bucket containing the zip archive which contains the function.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#source_archive_bucket CloudfunctionsFunction#source_archive_bucket}


source_archive_objectOptional
  • Type: str

The source archive object (file) in archive bucket.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#source_archive_object CloudfunctionsFunction#source_archive_object}


source_repositoryOptional

source_repository block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#source_repository CloudfunctionsFunction#source_repository}


timeoutOptional
  • Type: typing.Union[int, float]

Timeout (in seconds) for the function. Default value is 60 seconds. Cannot be more than 540 seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#timeout CloudfunctionsFunction#timeout}


timeoutsOptional

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#timeouts CloudfunctionsFunction#timeouts}


trigger_httpOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Boolean variable.

Any HTTP request (of a supported type) to the endpoint will trigger function execution. Supported HTTP request types are: POST, PUT, GET, DELETE, and OPTIONS. Endpoint is returned as https_trigger_url. Cannot be used with trigger_bucket and trigger_topic.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#trigger_http CloudfunctionsFunction#trigger_http}


vpc_connectorOptional
  • Type: str

The VPC Network Connector that this cloud function can connect to.

It can be either the fully-qualified URI, or the short name of the network connector resource. The format of this field is projects/* /locations/* /connectors/*.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#vpc_connector CloudfunctionsFunction#vpc_connector}

Note: The above comment contained a comment block ending sequence (* followed by /). We have introduced a space between to prevent syntax errors. Please ignore the space.


vpc_connector_egress_settingsOptional
  • Type: str

The egress settings for the connector, controlling what traffic is diverted through it.

Allowed values are ALL_TRAFFIC and PRIVATE_RANGES_ONLY. Defaults to PRIVATE_RANGES_ONLY. If unset, this field preserves the previously set value.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#vpc_connector_egress_settings CloudfunctionsFunction#vpc_connector_egress_settings}


Methods

Name Description
to_string Returns a string representation of this construct.
add_override No description.
override_logical_id Overrides the auto-generated logical ID with a specific ID.
reset_override_logical_id Resets a previously passed logical Id to use the auto-generated logical id again.
to_hcl_terraform No description.
to_metadata No description.
to_terraform Adds this resource to the terraform JSON output.
add_move_target Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
has_resource_move No description.
import_from No description.
interpolation_for_attribute No description.
move_from_id Move the resource corresponding to "id" to this resource.
move_to Moves this resource to the target resource given by moveTarget.
move_to_id Moves this resource to the resource corresponding to "id".
put_event_trigger No description.
put_secret_environment_variables No description.
put_secret_volumes No description.
put_source_repository No description.
put_timeouts No description.
reset_available_memory_mb No description.
reset_build_environment_variables No description.
reset_build_service_account No description.
reset_build_worker_pool No description.
reset_description No description.
reset_docker_registry No description.
reset_docker_repository No description.
reset_entry_point No description.
reset_environment_variables No description.
reset_event_trigger No description.
reset_https_trigger_security_level No description.
reset_https_trigger_url No description.
reset_id No description.
reset_ingress_settings No description.
reset_kms_key_name No description.
reset_labels No description.
reset_max_instances No description.
reset_min_instances No description.
reset_project No description.
reset_region No description.
reset_secret_environment_variables No description.
reset_secret_volumes No description.
reset_service_account_email No description.
reset_source_archive_bucket No description.
reset_source_archive_object No description.
reset_source_repository No description.
reset_timeout No description.
reset_timeouts No description.
reset_trigger_http No description.
reset_vpc_connector No description.
reset_vpc_connector_egress_settings No description.

to_string
def to_string() -> str

Returns a string representation of this construct.

add_override
def add_override(
  path: str,
  value: typing.Any
) -> None
pathRequired
  • Type: str

valueRequired
  • Type: typing.Any

override_logical_id
def override_logical_id(
  new_logical_id: str
) -> None

Overrides the auto-generated logical ID with a specific ID.

new_logical_idRequired
  • Type: str

The new logical ID to use for this stack element.


reset_override_logical_id
def reset_override_logical_id() -> None

Resets a previously passed logical Id to use the auto-generated logical id again.

to_hcl_terraform
def to_hcl_terraform() -> typing.Any
to_metadata
def to_metadata() -> typing.Any
to_terraform
def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

add_move_target
def add_move_target(
  move_target: str
) -> None

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

move_targetRequired
  • Type: str

The string move target that will correspond to this resource.


get_any_map_attribute
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str

get_boolean_attribute
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str

get_boolean_map_attribute
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str

get_list_attribute
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str

get_number_attribute
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str

get_number_list_attribute
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str

get_number_map_attribute
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str

get_string_attribute
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str

get_string_map_attribute
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str

has_resource_move
def has_resource_move() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]
import_from
def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None
idRequired
  • Type: str

providerOptional
  • Type: cdktf.TerraformProvider

interpolation_for_attribute
def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str

move_from_id
def move_from_id(
  id: str
) -> None

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: str

Full id of resource being moved from, e.g. "aws_s3_bucket.example".


move_to
def move_to(
  move_target: str,
  index: typing.Union[str, typing.Union[int, float]] = None
) -> None

Moves this resource to the target resource given by moveTarget.

move_targetRequired
  • Type: str

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.


indexOptional
  • Type: typing.Union[str, typing.Union[int, float]]

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.


move_to_id
def move_to_id(
  id: str
) -> None

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: str

Full id of resource to move to, e.g. "aws_s3_bucket.example".


put_event_trigger
def put_event_trigger(
  event_type: str,
  resource: str,
  failure_policy: CloudfunctionsFunctionEventTriggerFailurePolicy = None
) -> None
event_typeRequired
  • Type: str

The type of event to observe.

For example: "google.storage.object.finalize". See the documentation on calling Cloud Functions for a full reference of accepted triggers.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#event_type CloudfunctionsFunction#event_type}


resourceRequired
  • Type: str

The name or partial URI of the resource from which to observe events. For example, "myBucket" or "projects/my-project/topics/my-topic".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#resource CloudfunctionsFunction#resource}


failure_policyOptional

failure_policy block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#failure_policy CloudfunctionsFunction#failure_policy}


put_secret_environment_variables
def put_secret_environment_variables(
  value: typing.Union[IResolvable, typing.List[CloudfunctionsFunctionSecretEnvironmentVariables]]
) -> None
valueRequired

put_secret_volumes
def put_secret_volumes(
  value: typing.Union[IResolvable, typing.List[CloudfunctionsFunctionSecretVolumes]]
) -> None
valueRequired

put_source_repository
def put_source_repository(
  url: str
) -> None
urlRequired
  • Type: str

The URL pointing to the hosted repository where the function is defined.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#url CloudfunctionsFunction#url}


put_timeouts
def put_timeouts(
  create: str = None,
  delete: str = None,
  read: str = None,
  update: str = None
) -> None
createOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#create CloudfunctionsFunction#create}.


deleteOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#delete CloudfunctionsFunction#delete}.


readOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#read CloudfunctionsFunction#read}.


updateOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#update CloudfunctionsFunction#update}.


reset_available_memory_mb
def reset_available_memory_mb() -> None
reset_build_environment_variables
def reset_build_environment_variables() -> None
reset_build_service_account
def reset_build_service_account() -> None
reset_build_worker_pool
def reset_build_worker_pool() -> None
reset_description
def reset_description() -> None
reset_docker_registry
def reset_docker_registry() -> None
reset_docker_repository
def reset_docker_repository() -> None
reset_entry_point
def reset_entry_point() -> None
reset_environment_variables
def reset_environment_variables() -> None
reset_event_trigger
def reset_event_trigger() -> None
reset_https_trigger_security_level
def reset_https_trigger_security_level() -> None
reset_https_trigger_url
def reset_https_trigger_url() -> None
reset_id
def reset_id() -> None
reset_ingress_settings
def reset_ingress_settings() -> None
reset_kms_key_name
def reset_kms_key_name() -> None
reset_labels
def reset_labels() -> None
reset_max_instances
def reset_max_instances() -> None
reset_min_instances
def reset_min_instances() -> None
reset_project
def reset_project() -> None
reset_region
def reset_region() -> None
reset_secret_environment_variables
def reset_secret_environment_variables() -> None
reset_secret_volumes
def reset_secret_volumes() -> None
reset_service_account_email
def reset_service_account_email() -> None
reset_source_archive_bucket
def reset_source_archive_bucket() -> None
reset_source_archive_object
def reset_source_archive_object() -> None
reset_source_repository
def reset_source_repository() -> None
reset_timeout
def reset_timeout() -> None
reset_timeouts
def reset_timeouts() -> None
reset_trigger_http
def reset_trigger_http() -> None
reset_vpc_connector
def reset_vpc_connector() -> None
reset_vpc_connector_egress_settings
def reset_vpc_connector_egress_settings() -> None

Static Functions

Name Description
is_construct Checks if x is a construct.
is_terraform_element No description.
is_terraform_resource No description.
generate_config_for_import Generates CDKTF code for importing a CloudfunctionsFunction resource upon running "cdktf plan ".

is_construct
from cdktf_cdktf_provider_google import cloudfunctions_function

cloudfunctionsFunction.CloudfunctionsFunction.is_construct(
  x: typing.Any
)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: typing.Any

Any object.


is_terraform_element
from cdktf_cdktf_provider_google import cloudfunctions_function

cloudfunctionsFunction.CloudfunctionsFunction.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any

is_terraform_resource
from cdktf_cdktf_provider_google import cloudfunctions_function

cloudfunctionsFunction.CloudfunctionsFunction.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any

generate_config_for_import
from cdktf_cdktf_provider_google import cloudfunctions_function

cloudfunctionsFunction.CloudfunctionsFunction.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

Generates CDKTF code for importing a CloudfunctionsFunction resource upon running "cdktf plan ".

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


import_to_idRequired
  • Type: str

The construct id used in the generated config for the CloudfunctionsFunction to import.


import_from_idRequired
  • Type: str

The id of the existing CloudfunctionsFunction that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#import import section} in the documentation of this resource for the id to use


providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the CloudfunctionsFunction to import is found.


Properties

Name Type Description
node constructs.Node The tree node.
cdktf_stack cdktf.TerraformStack No description.
fqn str No description.
friendly_unique_id str No description.
terraform_meta_arguments typing.Mapping[typing.Any] No description.
terraform_resource_type str No description.
terraform_generator_metadata cdktf.TerraformProviderGeneratorMetadata No description.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[str] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
effective_labels cdktf.StringMap No description.
event_trigger CloudfunctionsFunctionEventTriggerOutputReference No description.
secret_environment_variables CloudfunctionsFunctionSecretEnvironmentVariablesList No description.
secret_volumes CloudfunctionsFunctionSecretVolumesList No description.
source_repository CloudfunctionsFunctionSourceRepositoryOutputReference No description.
status str No description.
terraform_labels cdktf.StringMap No description.
timeouts CloudfunctionsFunctionTimeoutsOutputReference No description.
version_id str No description.
available_memory_mb_input typing.Union[int, float] No description.
build_environment_variables_input typing.Mapping[str] No description.
build_service_account_input str No description.
build_worker_pool_input str No description.
description_input str No description.
docker_registry_input str No description.
docker_repository_input str No description.
entry_point_input str No description.
environment_variables_input typing.Mapping[str] No description.
event_trigger_input CloudfunctionsFunctionEventTrigger No description.
https_trigger_security_level_input str No description.
https_trigger_url_input str No description.
id_input str No description.
ingress_settings_input str No description.
kms_key_name_input str No description.
labels_input typing.Mapping[str] No description.
max_instances_input typing.Union[int, float] No description.
min_instances_input typing.Union[int, float] No description.
name_input str No description.
project_input str No description.
region_input str No description.
runtime_input str No description.
secret_environment_variables_input typing.Union[cdktf.IResolvable, typing.List[CloudfunctionsFunctionSecretEnvironmentVariables]] No description.
secret_volumes_input typing.Union[cdktf.IResolvable, typing.List[CloudfunctionsFunctionSecretVolumes]] No description.
service_account_email_input str No description.
source_archive_bucket_input str No description.
source_archive_object_input str No description.
source_repository_input CloudfunctionsFunctionSourceRepository No description.
timeout_input typing.Union[int, float] No description.
timeouts_input typing.Union[cdktf.IResolvable, CloudfunctionsFunctionTimeouts] No description.
trigger_http_input typing.Union[bool, cdktf.IResolvable] No description.
vpc_connector_egress_settings_input str No description.
vpc_connector_input str No description.
available_memory_mb typing.Union[int, float] No description.
build_environment_variables typing.Mapping[str] No description.
build_service_account str No description.
build_worker_pool str No description.
description str No description.
docker_registry str No description.
docker_repository str No description.
entry_point str No description.
environment_variables typing.Mapping[str] No description.
https_trigger_security_level str No description.
https_trigger_url str No description.
id str No description.
ingress_settings str No description.
kms_key_name str No description.
labels typing.Mapping[str] No description.
max_instances typing.Union[int, float] No description.
min_instances typing.Union[int, float] No description.
name str No description.
project str No description.
region str No description.
runtime str No description.
service_account_email str No description.
source_archive_bucket str No description.
source_archive_object str No description.
timeout typing.Union[int, float] No description.
trigger_http typing.Union[bool, cdktf.IResolvable] No description.
vpc_connector str No description.
vpc_connector_egress_settings str No description.

nodeRequired
node: Node
  • Type: constructs.Node

The tree node.


cdktf_stackRequired
cdktf_stack: TerraformStack
  • Type: cdktf.TerraformStack

fqnRequired
fqn: str
  • Type: str

friendly_unique_idRequired
friendly_unique_id: str
  • Type: str

terraform_meta_argumentsRequired
terraform_meta_arguments: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]

terraform_resource_typeRequired
terraform_resource_type: str
  • Type: str

terraform_generator_metadataOptional
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktf.TerraformProviderGeneratorMetadata

connectionOptional
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

countOptional
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

depends_onOptional
depends_on: typing.List[str]
  • Type: typing.List[str]

for_eachOptional
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator

lifecycleOptional
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
provider: TerraformProvider
  • Type: cdktf.TerraformProvider

provisionersOptional
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

effective_labelsRequired
effective_labels: StringMap
  • Type: cdktf.StringMap

event_triggerRequired
event_trigger: CloudfunctionsFunctionEventTriggerOutputReference

secret_environment_variablesRequired
secret_environment_variables: CloudfunctionsFunctionSecretEnvironmentVariablesList

secret_volumesRequired
secret_volumes: CloudfunctionsFunctionSecretVolumesList

source_repositoryRequired
source_repository: CloudfunctionsFunctionSourceRepositoryOutputReference

statusRequired
status: str
  • Type: str

terraform_labelsRequired
terraform_labels: StringMap
  • Type: cdktf.StringMap

timeoutsRequired
timeouts: CloudfunctionsFunctionTimeoutsOutputReference

version_idRequired
version_id: str
  • Type: str

available_memory_mb_inputOptional
available_memory_mb_input: typing.Union[int, float]
  • Type: typing.Union[int, float]

build_environment_variables_inputOptional
build_environment_variables_input: typing.Mapping[str]
  • Type: typing.Mapping[str]

build_service_account_inputOptional
build_service_account_input: str
  • Type: str

build_worker_pool_inputOptional
build_worker_pool_input: str
  • Type: str

description_inputOptional
description_input: str
  • Type: str

docker_registry_inputOptional
docker_registry_input: str
  • Type: str

docker_repository_inputOptional
docker_repository_input: str
  • Type: str

entry_point_inputOptional
entry_point_input: str
  • Type: str

environment_variables_inputOptional
environment_variables_input: typing.Mapping[str]
  • Type: typing.Mapping[str]

event_trigger_inputOptional
event_trigger_input: CloudfunctionsFunctionEventTrigger

https_trigger_security_level_inputOptional
https_trigger_security_level_input: str
  • Type: str

https_trigger_url_inputOptional
https_trigger_url_input: str
  • Type: str

id_inputOptional
id_input: str
  • Type: str

ingress_settings_inputOptional
ingress_settings_input: str
  • Type: str

kms_key_name_inputOptional
kms_key_name_input: str
  • Type: str

labels_inputOptional
labels_input: typing.Mapping[str]
  • Type: typing.Mapping[str]

max_instances_inputOptional
max_instances_input: typing.Union[int, float]
  • Type: typing.Union[int, float]

min_instances_inputOptional
min_instances_input: typing.Union[int, float]
  • Type: typing.Union[int, float]

name_inputOptional
name_input: str
  • Type: str

project_inputOptional
project_input: str
  • Type: str

region_inputOptional
region_input: str
  • Type: str

runtime_inputOptional
runtime_input: str
  • Type: str

secret_environment_variables_inputOptional
secret_environment_variables_input: typing.Union[IResolvable, typing.List[CloudfunctionsFunctionSecretEnvironmentVariables]]

secret_volumes_inputOptional
secret_volumes_input: typing.Union[IResolvable, typing.List[CloudfunctionsFunctionSecretVolumes]]

service_account_email_inputOptional
service_account_email_input: str
  • Type: str

source_archive_bucket_inputOptional
source_archive_bucket_input: str
  • Type: str

source_archive_object_inputOptional
source_archive_object_input: str
  • Type: str

source_repository_inputOptional
source_repository_input: CloudfunctionsFunctionSourceRepository

timeout_inputOptional
timeout_input: typing.Union[int, float]
  • Type: typing.Union[int, float]

timeouts_inputOptional
timeouts_input: typing.Union[IResolvable, CloudfunctionsFunctionTimeouts]

trigger_http_inputOptional
trigger_http_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

vpc_connector_egress_settings_inputOptional
vpc_connector_egress_settings_input: str
  • Type: str

vpc_connector_inputOptional
vpc_connector_input: str
  • Type: str

available_memory_mbRequired
available_memory_mb: typing.Union[int, float]
  • Type: typing.Union[int, float]

build_environment_variablesRequired
build_environment_variables: typing.Mapping[str]
  • Type: typing.Mapping[str]

build_service_accountRequired
build_service_account: str
  • Type: str

build_worker_poolRequired
build_worker_pool: str
  • Type: str

descriptionRequired
description: str
  • Type: str

docker_registryRequired
docker_registry: str
  • Type: str

docker_repositoryRequired
docker_repository: str
  • Type: str

entry_pointRequired
entry_point: str
  • Type: str

environment_variablesRequired
environment_variables: typing.Mapping[str]
  • Type: typing.Mapping[str]

https_trigger_security_levelRequired
https_trigger_security_level: str
  • Type: str

https_trigger_urlRequired
https_trigger_url: str
  • Type: str

idRequired
id: str
  • Type: str

ingress_settingsRequired
ingress_settings: str
  • Type: str

kms_key_nameRequired
kms_key_name: str
  • Type: str

labelsRequired
labels: typing.Mapping[str]
  • Type: typing.Mapping[str]

max_instancesRequired
max_instances: typing.Union[int, float]
  • Type: typing.Union[int, float]

min_instancesRequired
min_instances: typing.Union[int, float]
  • Type: typing.Union[int, float]

nameRequired
name: str
  • Type: str

projectRequired
project: str
  • Type: str

regionRequired
region: str
  • Type: str

runtimeRequired
runtime: str
  • Type: str

service_account_emailRequired
service_account_email: str
  • Type: str

source_archive_bucketRequired
source_archive_bucket: str
  • Type: str

source_archive_objectRequired
source_archive_object: str
  • Type: str

timeoutRequired
timeout: typing.Union[int, float]
  • Type: typing.Union[int, float]

trigger_httpRequired
trigger_http: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

vpc_connectorRequired
vpc_connector: str
  • Type: str

vpc_connector_egress_settingsRequired
vpc_connector_egress_settings: str
  • Type: str

Constants

Name Type Description
tfResourceType str No description.

tfResourceTypeRequired
tfResourceType: str
  • Type: str

Structs

CloudfunctionsFunctionConfig

Initializer

from cdktf_cdktf_provider_google import cloudfunctions_function

cloudfunctionsFunction.CloudfunctionsFunctionConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  name: str,
  runtime: str,
  available_memory_mb: typing.Union[int, float] = None,
  build_environment_variables: typing.Mapping[str] = None,
  build_service_account: str = None,
  build_worker_pool: str = None,
  description: str = None,
  docker_registry: str = None,
  docker_repository: str = None,
  entry_point: str = None,
  environment_variables: typing.Mapping[str] = None,
  event_trigger: CloudfunctionsFunctionEventTrigger = None,
  https_trigger_security_level: str = None,
  https_trigger_url: str = None,
  id: str = None,
  ingress_settings: str = None,
  kms_key_name: str = None,
  labels: typing.Mapping[str] = None,
  max_instances: typing.Union[int, float] = None,
  min_instances: typing.Union[int, float] = None,
  project: str = None,
  region: str = None,
  secret_environment_variables: typing.Union[IResolvable, typing.List[CloudfunctionsFunctionSecretEnvironmentVariables]] = None,
  secret_volumes: typing.Union[IResolvable, typing.List[CloudfunctionsFunctionSecretVolumes]] = None,
  service_account_email: str = None,
  source_archive_bucket: str = None,
  source_archive_object: str = None,
  source_repository: CloudfunctionsFunctionSourceRepository = None,
  timeout: typing.Union[int, float] = None,
  timeouts: CloudfunctionsFunctionTimeouts = None,
  trigger_http: typing.Union[bool, IResolvable] = None,
  vpc_connector: str = None,
  vpc_connector_egress_settings: str = None
)

Properties

Name Type Description
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
name str A user-defined name of the function. Function names must be unique globally.
runtime str The runtime in which the function is going to run. Eg. "nodejs20", "python37", "go111".
available_memory_mb typing.Union[int, float] Memory (in MB), available to the function. Default value is 256. Possible values include 128, 256, 512, 1024, etc.
build_environment_variables typing.Mapping[str] A set of key/value environment variable pairs available during build time.
build_service_account str The fully-qualified name of the service account to be used for the build step of deploying this function.
build_worker_pool str Name of the Cloud Build Custom Worker Pool that should be used to build the function.
description str Description of the function.
docker_registry str Docker Registry to use for storing the function's Docker images. Allowed values are ARTIFACT_REGISTRY (default) and CONTAINER_REGISTRY.
docker_repository str User managed repository created in Artifact Registry optionally with a customer managed encryption key.
entry_point str Name of the function that will be executed when the Google Cloud Function is triggered.
environment_variables typing.Mapping[str] A set of key/value environment variable pairs to assign to the function.
event_trigger CloudfunctionsFunctionEventTrigger event_trigger block.
https_trigger_security_level str The security level for the function. Defaults to SECURE_OPTIONAL. Valid only if trigger_http is used.
https_trigger_url str URL which triggers function execution. Returned only if trigger_http is used.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#id CloudfunctionsFunction#id}.
ingress_settings str String value that controls what traffic can reach the function.
kms_key_name str Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function resources.
labels typing.Mapping[str] A set of key/value label pairs to assign to the function. Label keys must follow the requirements at https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements.
max_instances typing.Union[int, float] The limit on the maximum number of function instances that may coexist at a given time.
min_instances typing.Union[int, float] The limit on the minimum number of function instances that may coexist at a given time.
project str Project of the function. If it is not provided, the provider project is used.
region str Region of function. If it is not provided, the provider region is used.
secret_environment_variables typing.Union[cdktf.IResolvable, typing.List[CloudfunctionsFunctionSecretEnvironmentVariables]] secret_environment_variables block.
secret_volumes typing.Union[cdktf.IResolvable, typing.List[CloudfunctionsFunctionSecretVolumes]] secret_volumes block.
service_account_email str If provided, the self-provided service account to run the function with.
source_archive_bucket str The GCS bucket containing the zip archive which contains the function.
source_archive_object str The source archive object (file) in archive bucket.
source_repository CloudfunctionsFunctionSourceRepository source_repository block.
timeout typing.Union[int, float] Timeout (in seconds) for the function. Default value is 60 seconds. Cannot be more than 540 seconds.
timeouts CloudfunctionsFunctionTimeouts timeouts block.
trigger_http typing.Union[bool, cdktf.IResolvable] Boolean variable.
vpc_connector str The VPC Network Connector that this cloud function can connect to.
vpc_connector_egress_settings str The egress settings for the connector, controlling what traffic is diverted through it.

connectionOptional
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

countOptional
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

depends_onOptional
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktf.ITerraformDependable]

for_eachOptional
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator

lifecycleOptional
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
provider: TerraformProvider
  • Type: cdktf.TerraformProvider

provisionersOptional
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

nameRequired
name: str
  • Type: str

A user-defined name of the function. Function names must be unique globally.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#name CloudfunctionsFunction#name}


runtimeRequired
runtime: str
  • Type: str

The runtime in which the function is going to run. Eg. "nodejs20", "python37", "go111".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#runtime CloudfunctionsFunction#runtime}


available_memory_mbOptional
available_memory_mb: typing.Union[int, float]
  • Type: typing.Union[int, float]

Memory (in MB), available to the function. Default value is 256. Possible values include 128, 256, 512, 1024, etc.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#available_memory_mb CloudfunctionsFunction#available_memory_mb}


build_environment_variablesOptional
build_environment_variables: typing.Mapping[str]
  • Type: typing.Mapping[str]

A set of key/value environment variable pairs available during build time.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#build_environment_variables CloudfunctionsFunction#build_environment_variables}


build_service_accountOptional
build_service_account: str
  • Type: str

The fully-qualified name of the service account to be used for the build step of deploying this function.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#build_service_account CloudfunctionsFunction#build_service_account}


build_worker_poolOptional
build_worker_pool: str
  • Type: str

Name of the Cloud Build Custom Worker Pool that should be used to build the function.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#build_worker_pool CloudfunctionsFunction#build_worker_pool}


descriptionOptional
description: str
  • Type: str

Description of the function.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#description CloudfunctionsFunction#description}


docker_registryOptional
docker_registry: str
  • Type: str

Docker Registry to use for storing the function's Docker images. Allowed values are ARTIFACT_REGISTRY (default) and CONTAINER_REGISTRY.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#docker_registry CloudfunctionsFunction#docker_registry}


docker_repositoryOptional
docker_repository: str
  • Type: str

User managed repository created in Artifact Registry optionally with a customer managed encryption key.

If specified, deployments will use Artifact Registry for storing images built with Cloud Build.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#docker_repository CloudfunctionsFunction#docker_repository}


entry_pointOptional
entry_point: str
  • Type: str

Name of the function that will be executed when the Google Cloud Function is triggered.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#entry_point CloudfunctionsFunction#entry_point}


environment_variablesOptional
environment_variables: typing.Mapping[str]
  • Type: typing.Mapping[str]

A set of key/value environment variable pairs to assign to the function.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#environment_variables CloudfunctionsFunction#environment_variables}


event_triggerOptional
event_trigger: CloudfunctionsFunctionEventTrigger

event_trigger block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#event_trigger CloudfunctionsFunction#event_trigger}


https_trigger_security_levelOptional
https_trigger_security_level: str
  • Type: str

The security level for the function. Defaults to SECURE_OPTIONAL. Valid only if trigger_http is used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#https_trigger_security_level CloudfunctionsFunction#https_trigger_security_level}


https_trigger_urlOptional
https_trigger_url: str
  • Type: str

URL which triggers function execution. Returned only if trigger_http is used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#https_trigger_url CloudfunctionsFunction#https_trigger_url}


idOptional
id: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#id CloudfunctionsFunction#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.


ingress_settingsOptional
ingress_settings: str
  • Type: str

String value that controls what traffic can reach the function.

Allowed values are ALLOW_ALL and ALLOW_INTERNAL_ONLY. Changes to this field will recreate the cloud function.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#ingress_settings CloudfunctionsFunction#ingress_settings}


kms_key_nameOptional
kms_key_name: str
  • Type: str

Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function resources.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#kms_key_name CloudfunctionsFunction#kms_key_name}


labelsOptional
labels: typing.Mapping[str]
  • Type: typing.Mapping[str]

A set of key/value label pairs to assign to the function. Label keys must follow the requirements at https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#labels CloudfunctionsFunction#labels}


max_instancesOptional
max_instances: typing.Union[int, float]
  • Type: typing.Union[int, float]

The limit on the maximum number of function instances that may coexist at a given time.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#max_instances CloudfunctionsFunction#max_instances}


min_instancesOptional
min_instances: typing.Union[int, float]
  • Type: typing.Union[int, float]

The limit on the minimum number of function instances that may coexist at a given time.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#min_instances CloudfunctionsFunction#min_instances}


projectOptional
project: str
  • Type: str

Project of the function. If it is not provided, the provider project is used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#project CloudfunctionsFunction#project}


regionOptional
region: str
  • Type: str

Region of function. If it is not provided, the provider region is used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#region CloudfunctionsFunction#region}


secret_environment_variablesOptional
secret_environment_variables: typing.Union[IResolvable, typing.List[CloudfunctionsFunctionSecretEnvironmentVariables]]

secret_environment_variables block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#secret_environment_variables CloudfunctionsFunction#secret_environment_variables}


secret_volumesOptional
secret_volumes: typing.Union[IResolvable, typing.List[CloudfunctionsFunctionSecretVolumes]]

secret_volumes block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#secret_volumes CloudfunctionsFunction#secret_volumes}


service_account_emailOptional
service_account_email: str
  • Type: str

If provided, the self-provided service account to run the function with.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#service_account_email CloudfunctionsFunction#service_account_email}


source_archive_bucketOptional
source_archive_bucket: str
  • Type: str

The GCS bucket containing the zip archive which contains the function.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#source_archive_bucket CloudfunctionsFunction#source_archive_bucket}


source_archive_objectOptional
source_archive_object: str
  • Type: str

The source archive object (file) in archive bucket.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#source_archive_object CloudfunctionsFunction#source_archive_object}


source_repositoryOptional
source_repository: CloudfunctionsFunctionSourceRepository

source_repository block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#source_repository CloudfunctionsFunction#source_repository}


timeoutOptional
timeout: typing.Union[int, float]
  • Type: typing.Union[int, float]

Timeout (in seconds) for the function. Default value is 60 seconds. Cannot be more than 540 seconds.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#timeout CloudfunctionsFunction#timeout}


timeoutsOptional
timeouts: CloudfunctionsFunctionTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#timeouts CloudfunctionsFunction#timeouts}


trigger_httpOptional
trigger_http: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Boolean variable.

Any HTTP request (of a supported type) to the endpoint will trigger function execution. Supported HTTP request types are: POST, PUT, GET, DELETE, and OPTIONS. Endpoint is returned as https_trigger_url. Cannot be used with trigger_bucket and trigger_topic.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#trigger_http CloudfunctionsFunction#trigger_http}


vpc_connectorOptional
vpc_connector: str
  • Type: str

The VPC Network Connector that this cloud function can connect to.

It can be either the fully-qualified URI, or the short name of the network connector resource. The format of this field is projects/* /locations/* /connectors/*.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#vpc_connector CloudfunctionsFunction#vpc_connector}

Note: The above comment contained a comment block ending sequence (* followed by /). We have introduced a space between to prevent syntax errors. Please ignore the space.


vpc_connector_egress_settingsOptional
vpc_connector_egress_settings: str
  • Type: str

The egress settings for the connector, controlling what traffic is diverted through it.

Allowed values are ALL_TRAFFIC and PRIVATE_RANGES_ONLY. Defaults to PRIVATE_RANGES_ONLY. If unset, this field preserves the previously set value.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#vpc_connector_egress_settings CloudfunctionsFunction#vpc_connector_egress_settings}


CloudfunctionsFunctionEventTrigger

Initializer

from cdktf_cdktf_provider_google import cloudfunctions_function

cloudfunctionsFunction.CloudfunctionsFunctionEventTrigger(
  event_type: str,
  resource: str,
  failure_policy: CloudfunctionsFunctionEventTriggerFailurePolicy = None
)

Properties

Name Type Description
event_type str The type of event to observe.
resource str The name or partial URI of the resource from which to observe events. For example, "myBucket" or "projects/my-project/topics/my-topic".
failure_policy CloudfunctionsFunctionEventTriggerFailurePolicy failure_policy block.

event_typeRequired
event_type: str
  • Type: str

The type of event to observe.

For example: "google.storage.object.finalize". See the documentation on calling Cloud Functions for a full reference of accepted triggers.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#event_type CloudfunctionsFunction#event_type}


resourceRequired
resource: str
  • Type: str

The name or partial URI of the resource from which to observe events. For example, "myBucket" or "projects/my-project/topics/my-topic".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#resource CloudfunctionsFunction#resource}


failure_policyOptional
failure_policy: CloudfunctionsFunctionEventTriggerFailurePolicy

failure_policy block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#failure_policy CloudfunctionsFunction#failure_policy}


CloudfunctionsFunctionEventTriggerFailurePolicy

Initializer

from cdktf_cdktf_provider_google import cloudfunctions_function

cloudfunctionsFunction.CloudfunctionsFunctionEventTriggerFailurePolicy(
  retry: typing.Union[bool, IResolvable]
)

Properties

Name Type Description
retry typing.Union[bool, cdktf.IResolvable] Whether the function should be retried on failure. Defaults to false.

retryRequired
retry: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Whether the function should be retried on failure. Defaults to false.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#retry CloudfunctionsFunction#retry}


CloudfunctionsFunctionSecretEnvironmentVariables

Initializer

from cdktf_cdktf_provider_google import cloudfunctions_function

cloudfunctionsFunction.CloudfunctionsFunctionSecretEnvironmentVariables(
  key: str,
  secret: str,
  version: str,
  project_id: str = None
)

Properties

Name Type Description
key str Name of the environment variable.
secret str ID of the secret in secret manager (not the full resource name).
version str Version of the secret (version number or the string "latest").
project_id str Project identifier (due to a known limitation, only project number is supported by this field) of the project that contains the secret.

keyRequired
key: str
  • Type: str

Name of the environment variable.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#key CloudfunctionsFunction#key}


secretRequired
secret: str
  • Type: str

ID of the secret in secret manager (not the full resource name).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#secret CloudfunctionsFunction#secret}


versionRequired
version: str
  • Type: str

Version of the secret (version number or the string "latest").

It is recommended to use a numeric version for secret environment variables as any updates to the secret value is not reflected until new clones start.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#version CloudfunctionsFunction#version}


project_idOptional
project_id: str
  • Type: str

Project identifier (due to a known limitation, only project number is supported by this field) of the project that contains the secret.

If not set, it will be populated with the function's project, assuming that the secret exists in the same project as of the function.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#project_id CloudfunctionsFunction#project_id}


CloudfunctionsFunctionSecretVolumes

Initializer

from cdktf_cdktf_provider_google import cloudfunctions_function

cloudfunctionsFunction.CloudfunctionsFunctionSecretVolumes(
  mount_path: str,
  secret: str,
  project_id: str = None,
  versions: typing.Union[IResolvable, typing.List[CloudfunctionsFunctionSecretVolumesVersions]] = None
)

Properties

Name Type Description
mount_path str The path within the container to mount the secret volume.
secret str ID of the secret in secret manager (not the full resource name).
project_id str Project identifier (due to a known limitation, only project number is supported by this field) of the project that contains the secret.
versions typing.Union[cdktf.IResolvable, typing.List[CloudfunctionsFunctionSecretVolumesVersions]] versions block.

mount_pathRequired
mount_path: str
  • Type: str

The path within the container to mount the secret volume.

For example, setting the mount_path as "/etc/secrets" would mount the secret value files under the "/etc/secrets" directory. This directory will also be completely shadowed and unavailable to mount any other secrets. Recommended mount paths: "/etc/secrets" Restricted mount paths: "/cloudsql", "/dev/log", "/pod", "/proc", "/var/log".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#mount_path CloudfunctionsFunction#mount_path}


secretRequired
secret: str
  • Type: str

ID of the secret in secret manager (not the full resource name).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#secret CloudfunctionsFunction#secret}


project_idOptional
project_id: str
  • Type: str

Project identifier (due to a known limitation, only project number is supported by this field) of the project that contains the secret.

If not set, it will be populated with the function's project, assuming that the secret exists in the same project as of the function.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#project_id CloudfunctionsFunction#project_id}


versionsOptional
versions: typing.Union[IResolvable, typing.List[CloudfunctionsFunctionSecretVolumesVersions]]

versions block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#versions CloudfunctionsFunction#versions}


CloudfunctionsFunctionSecretVolumesVersions

Initializer

from cdktf_cdktf_provider_google import cloudfunctions_function

cloudfunctionsFunction.CloudfunctionsFunctionSecretVolumesVersions(
  path: str,
  version: str
)

Properties

Name Type Description
path str Relative path of the file under the mount path where the secret value for this version will be fetched and made available.
version str Version of the secret (version number or the string "latest").

pathRequired
path: str
  • Type: str

Relative path of the file under the mount path where the secret value for this version will be fetched and made available.

For example, setting the mount_path as "/etc/secrets" and path as "/secret_foo" would mount the secret value file at "/etc/secrets/secret_foo".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#path CloudfunctionsFunction#path}


versionRequired
version: str
  • Type: str

Version of the secret (version number or the string "latest").

It is preferable to use "latest" version with secret volumes as secret value changes are reflected immediately.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#version CloudfunctionsFunction#version}


CloudfunctionsFunctionSourceRepository

Initializer

from cdktf_cdktf_provider_google import cloudfunctions_function

cloudfunctionsFunction.CloudfunctionsFunctionSourceRepository(
  url: str
)

Properties

Name Type Description
url str The URL pointing to the hosted repository where the function is defined.

urlRequired
url: str
  • Type: str

The URL pointing to the hosted repository where the function is defined.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#url CloudfunctionsFunction#url}


CloudfunctionsFunctionTimeouts

Initializer

from cdktf_cdktf_provider_google import cloudfunctions_function

cloudfunctionsFunction.CloudfunctionsFunctionTimeouts(
  create: str = None,
  delete: str = None,
  read: str = None,
  update: str = None
)

Properties

Name Type Description
create str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#create CloudfunctionsFunction#create}.
delete str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#delete CloudfunctionsFunction#delete}.
read str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#read CloudfunctionsFunction#read}.
update str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#update CloudfunctionsFunction#update}.

createOptional
create: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#create CloudfunctionsFunction#create}.


deleteOptional
delete: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#delete CloudfunctionsFunction#delete}.


readOptional
read: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#read CloudfunctionsFunction#read}.


updateOptional
update: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#update CloudfunctionsFunction#update}.


Classes

CloudfunctionsFunctionEventTriggerFailurePolicyOutputReference

Initializers

from cdktf_cdktf_provider_google import cloudfunctions_function

cloudfunctionsFunction.CloudfunctionsFunctionEventTriggerFailurePolicyOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.

terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.


Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.

compute_fqn
def compute_fqn() -> str
get_any_map_attribute
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str

get_boolean_attribute
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str

get_boolean_map_attribute
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str

get_list_attribute
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str

get_number_attribute
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str

get_number_list_attribute
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str

get_number_map_attribute
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str

get_string_attribute
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str

get_string_map_attribute
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str

interpolation_for_attribute
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str

resolve
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

to_string
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
retry_input typing.Union[bool, cdktf.IResolvable] No description.
retry typing.Union[bool, cdktf.IResolvable] No description.
internal_value CloudfunctionsFunctionEventTriggerFailurePolicy No description.

creation_stackRequired
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


fqnRequired
fqn: str
  • Type: str

retry_inputOptional
retry_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

retryRequired
retry: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

internal_valueOptional
internal_value: CloudfunctionsFunctionEventTriggerFailurePolicy

CloudfunctionsFunctionEventTriggerOutputReference

Initializers

from cdktf_cdktf_provider_google import cloudfunctions_function

cloudfunctionsFunction.CloudfunctionsFunctionEventTriggerOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.

terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.


Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
put_failure_policy No description.
reset_failure_policy No description.

compute_fqn
def compute_fqn() -> str
get_any_map_attribute
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str

get_boolean_attribute
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str

get_boolean_map_attribute
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str

get_list_attribute
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str

get_number_attribute
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str

get_number_list_attribute
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str

get_number_map_attribute
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str

get_string_attribute
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str

get_string_map_attribute
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str

interpolation_for_attribute
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str

resolve
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

to_string
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

put_failure_policy
def put_failure_policy(
  retry: typing.Union[bool, IResolvable]
) -> None
retryRequired
  • Type: typing.Union[bool, cdktf.IResolvable]

Whether the function should be retried on failure. Defaults to false.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.0/docs/resources/cloudfunctions_function#retry CloudfunctionsFunction#retry}


reset_failure_policy
def reset_failure_policy() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
failure_policy CloudfunctionsFunctionEventTriggerFailurePolicyOutputReference No description.
event_type_input str No description.
failure_policy_input CloudfunctionsFunctionEventTriggerFailurePolicy No description.
resource_input str No description.
event_type str No description.
resource str No description.
internal_value CloudfunctionsFunctionEventTrigger No description.

creation_stackRequired
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


fqnRequired
fqn: str
  • Type: str

failure_policyRequired
failure_policy: CloudfunctionsFunctionEventTriggerFailurePolicyOutputReference

event_type_inputOptional
event_type_input: str
  • Type: str

failure_policy_inputOptional
failure_policy_input: CloudfunctionsFunctionEventTriggerFailurePolicy

resource_inputOptional
resource_input: str
  • Type: str

event_typeRequired
event_type: str
  • Type: str

resourceRequired
resource: str
  • Type: str

internal_valueOptional
internal_value: CloudfunctionsFunctionEventTrigger

CloudfunctionsFunctionSecretEnvironmentVariablesList

Initializers

from cdktf_cdktf_provider_google import cloudfunctions_function

cloudfunctionsFunction.CloudfunctionsFunctionSecretEnvironmentVariablesList(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  wraps_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
wraps_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.


wraps_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


Methods

Name Description
all_with_map_key Creating an iterator for this complex list.
compute_fqn No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
get No description.

all_with_map_key
def all_with_map_key(
  map_key_attribute_name: str
) -> DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

map_key_attribute_nameRequired
  • Type: str

compute_fqn
def compute_fqn() -> str
resolve
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

to_string
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

get
def get(
  index: typing.Union[int, float]
) -> CloudfunctionsFunctionSecretEnvironmentVariablesOutputReference
indexRequired
  • Type: typing.Union[int, float]

the index of the item to return.


Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
internal_value typing.Union[cdktf.IResolvable, typing.List[CloudfunctionsFunctionSecretEnvironmentVariables]] No description.

creation_stackRequired
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


fqnRequired
fqn: str
  • Type: str

internal_valueOptional
internal_value: typing.Union[IResolvable, typing.List[CloudfunctionsFunctionSecretEnvironmentVariables]]

CloudfunctionsFunctionSecretEnvironmentVariablesOutputReference

Initializers

from cdktf_cdktf_provider_google import cloudfunctions_function

cloudfunctionsFunction.CloudfunctionsFunctionSecretEnvironmentVariablesOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  complex_object_index: typing.Union[int, float],
  complex_object_is_from_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
complex_object_index typing.Union[int, float] the index of this item in the list.
complex_object_is_from_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.


complex_object_indexRequired
  • Type: typing.Union[int, float]

the index of this item in the list.


complex_object_is_from_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
reset_project_id No description.

compute_fqn
def compute_fqn() -> str
get_any_map_attribute
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str

get_boolean_attribute
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str

get_boolean_map_attribute
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str

get_list_attribute
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str

get_number_attribute
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str

get_number_list_attribute
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str

get_number_map_attribute
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str

get_string_attribute
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str

get_string_map_attribute
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str

interpolation_for_attribute
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str

resolve
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

to_string
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_project_id
def reset_project_id() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
key_input str No description.
project_id_input str No description.
secret_input str No description.
version_input str No description.
key str No description.
project_id str No description.
secret str No description.
version str No description.
internal_value typing.Union[cdktf.IResolvable, CloudfunctionsFunctionSecretEnvironmentVariables] No description.

creation_stackRequired
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


fqnRequired
fqn: str
  • Type: str

key_inputOptional
key_input: str
  • Type: str

project_id_inputOptional
project_id_input: str
  • Type: str

secret_inputOptional
secret_input: str
  • Type: str

version_inputOptional
version_input: str
  • Type: str

keyRequired
key: str
  • Type: str

project_idRequired
project_id: str
  • Type: str

secretRequired
secret: str
  • Type: str

versionRequired
version: str
  • Type: str

internal_valueOptional
internal_value: typing.Union[IResolvable, CloudfunctionsFunctionSecretEnvironmentVariables]

CloudfunctionsFunctionSecretVolumesList

Initializers

from cdktf_cdktf_provider_google import cloudfunctions_function

cloudfunctionsFunction.CloudfunctionsFunctionSecretVolumesList(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  wraps_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
wraps_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.


wraps_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


Methods

Name Description
all_with_map_key Creating an iterator for this complex list.
compute_fqn No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
get No description.

all_with_map_key
def all_with_map_key(
  map_key_attribute_name: str
) -> DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

map_key_attribute_nameRequired
  • Type: str

compute_fqn
def compute_fqn() -> str
resolve
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

to_string
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

get
def get(
  index: typing.Union[int, float]
) -> CloudfunctionsFunctionSecretVolumesOutputReference
indexRequired
  • Type: typing.Union[int, float]

the index of the item to return.


Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
internal_value typing.Union[cdktf.IResolvable, typing.List[CloudfunctionsFunctionSecretVolumes]] No description.

creation_stackRequired
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


fqnRequired
fqn: str
  • Type: str

internal_valueOptional
internal_value: typing.Union[IResolvable, typing.List[CloudfunctionsFunctionSecretVolumes]]

CloudfunctionsFunctionSecretVolumesOutputReference

Initializers

from cdktf_cdktf_provider_google import cloudfunctions_function

cloudfunctionsFunction.CloudfunctionsFunctionSecretVolumesOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  complex_object_index: typing.Union[int, float],
  complex_object_is_from_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
complex_object_index typing.Union[int, float] the index of this item in the list.
complex_object_is_from_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.


complex_object_indexRequired
  • Type: typing.Union[int, float]

the index of this item in the list.


complex_object_is_from_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
put_versions No description.
reset_project_id No description.
reset_versions No description.

compute_fqn
def compute_fqn() -> str
get_any_map_attribute
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str

get_boolean_attribute
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str

get_boolean_map_attribute
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str

get_list_attribute
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str

get_number_attribute
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str

get_number_list_attribute
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str

get_number_map_attribute
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str

get_string_attribute
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str

get_string_map_attribute
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str

interpolation_for_attribute
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str

resolve
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

to_string
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

put_versions
def put_versions(
  value: typing.Union[IResolvable, typing.List[CloudfunctionsFunctionSecretVolumesVersions]]
) -> None
valueRequired

reset_project_id
def reset_project_id() -> None
reset_versions
def reset_versions() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
versions CloudfunctionsFunctionSecretVolumesVersionsList No description.
mount_path_input str No description.
project_id_input str No description.
secret_input str No description.
versions_input typing.Union[cdktf.IResolvable, typing.List[CloudfunctionsFunctionSecretVolumesVersions]] No description.
mount_path str No description.
project_id str No description.
secret str No description.
internal_value typing.Union[cdktf.IResolvable, CloudfunctionsFunctionSecretVolumes] No description.

creation_stackRequired
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


fqnRequired
fqn: str
  • Type: str

versionsRequired
versions: CloudfunctionsFunctionSecretVolumesVersionsList

mount_path_inputOptional
mount_path_input: str
  • Type: str

project_id_inputOptional
project_id_input: str
  • Type: str

secret_inputOptional
secret_input: str
  • Type: str

versions_inputOptional
versions_input: typing.Union[IResolvable, typing.List[CloudfunctionsFunctionSecretVolumesVersions]]

mount_pathRequired
mount_path: str
  • Type: str

project_idRequired
project_id: str
  • Type: str

secretRequired
secret: str
  • Type: str

internal_valueOptional
internal_value: typing.Union[IResolvable, CloudfunctionsFunctionSecretVolumes]

CloudfunctionsFunctionSecretVolumesVersionsList

Initializers

from cdktf_cdktf_provider_google import cloudfunctions_function

cloudfunctionsFunction.CloudfunctionsFunctionSecretVolumesVersionsList(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  wraps_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
wraps_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.


wraps_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


Methods

Name Description
all_with_map_key Creating an iterator for this complex list.
compute_fqn No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
get No description.

all_with_map_key
def all_with_map_key(
  map_key_attribute_name: str
) -> DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

map_key_attribute_nameRequired
  • Type: str

compute_fqn
def compute_fqn() -> str
resolve
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

to_string
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

get
def get(
  index: typing.Union[int, float]
) -> CloudfunctionsFunctionSecretVolumesVersionsOutputReference
indexRequired
  • Type: typing.Union[int, float]

the index of the item to return.


Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
internal_value typing.Union[cdktf.IResolvable, typing.List[CloudfunctionsFunctionSecretVolumesVersions]] No description.

creation_stackRequired
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


fqnRequired
fqn: str
  • Type: str

internal_valueOptional
internal_value: typing.Union[IResolvable, typing.List[CloudfunctionsFunctionSecretVolumesVersions]]

CloudfunctionsFunctionSecretVolumesVersionsOutputReference

Initializers

from cdktf_cdktf_provider_google import cloudfunctions_function

cloudfunctionsFunction.CloudfunctionsFunctionSecretVolumesVersionsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  complex_object_index: typing.Union[int, float],
  complex_object_is_from_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
complex_object_index typing.Union[int, float] the index of this item in the list.
complex_object_is_from_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.


complex_object_indexRequired
  • Type: typing.Union[int, float]

the index of this item in the list.


complex_object_is_from_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).


Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.

compute_fqn
def compute_fqn() -> str
get_any_map_attribute
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str

get_boolean_attribute
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str

get_boolean_map_attribute
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str

get_list_attribute
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str

get_number_attribute
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str

get_number_list_attribute
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str

get_number_map_attribute
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str

get_string_attribute
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str

get_string_map_attribute
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str

interpolation_for_attribute
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str

resolve
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

to_string
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
path_input str No description.
version_input str No description.
path str No description.
version str No description.
internal_value typing.Union[cdktf.IResolvable, CloudfunctionsFunctionSecretVolumesVersions] No description.

creation_stackRequired
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


fqnRequired
fqn: str
  • Type: str

path_inputOptional
path_input: str
  • Type: str

version_inputOptional
version_input: str
  • Type: str

pathRequired
path: str
  • Type: str

versionRequired
version: str
  • Type: str

internal_valueOptional
internal_value: typing.Union[IResolvable, CloudfunctionsFunctionSecretVolumesVersions]

CloudfunctionsFunctionSourceRepositoryOutputReference

Initializers

from cdktf_cdktf_provider_google import cloudfunctions_function

cloudfunctionsFunction.CloudfunctionsFunctionSourceRepositoryOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.

terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.


Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.

compute_fqn
def compute_fqn() -> str
get_any_map_attribute
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str

get_boolean_attribute
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str

get_boolean_map_attribute
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str

get_list_attribute
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str

get_number_attribute
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str

get_number_list_attribute
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str

get_number_map_attribute
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str

get_string_attribute
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str

get_string_map_attribute
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str

interpolation_for_attribute
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str

resolve
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

to_string
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
deployed_url str No description.
url_input str No description.
url str No description.
internal_value CloudfunctionsFunctionSourceRepository No description.

creation_stackRequired
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


fqnRequired
fqn: str
  • Type: str

deployed_urlRequired
deployed_url: str
  • Type: str

url_inputOptional
url_input: str
  • Type: str

urlRequired
url: str
  • Type: str

internal_valueOptional
internal_value: CloudfunctionsFunctionSourceRepository

CloudfunctionsFunctionTimeoutsOutputReference

Initializers

from cdktf_cdktf_provider_google import cloudfunctions_function

cloudfunctionsFunction.CloudfunctionsFunctionTimeoutsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.

terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.


Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
reset_create No description.
reset_delete No description.
reset_read No description.
reset_update No description.

compute_fqn
def compute_fqn() -> str
get_any_map_attribute
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str

get_boolean_attribute
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str

get_boolean_map_attribute
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str

get_list_attribute
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str

get_number_attribute
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str

get_number_list_attribute
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str

get_number_map_attribute
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str

get_string_attribute
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str

get_string_map_attribute
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str

interpolation_for_attribute
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str

resolve
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

to_string
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_create
def reset_create() -> None
reset_delete
def reset_delete() -> None
reset_read
def reset_read() -> None
reset_update
def reset_update() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
create_input str No description.
delete_input str No description.
read_input str No description.
update_input str No description.
create str No description.
delete str No description.
read str No description.
update str No description.
internal_value typing.Union[cdktf.IResolvable, CloudfunctionsFunctionTimeouts] No description.

creation_stackRequired
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.


fqnRequired
fqn: str
  • Type: str

create_inputOptional
create_input: str
  • Type: str

delete_inputOptional
delete_input: str
  • Type: str

read_inputOptional
read_input: str
  • Type: str

update_inputOptional
update_input: str
  • Type: str

createRequired
create: str
  • Type: str

deleteRequired
delete: str
  • Type: str

readRequired
read: str
  • Type: str

updateRequired
update: str
  • Type: str

internal_valueOptional
internal_value: typing.Union[IResolvable, CloudfunctionsFunctionTimeouts]