Package com.hashicorp.cdktf.providers.google.cloudfunctions_function

Interface CloudfunctionsFunctionConfig

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments
    All Known Implementing Classes:
    CloudfunctionsFunctionConfig.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:18.224Z")
@Stability(Stable)
public interface CloudfunctionsFunctionConfig
extends software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments

    • Method Detail

      • getName

        @Stability(Stable)
@NotNull
String getName()
        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/5.43.1/docs/resources/cloudfunctions_function#name CloudfunctionsFunction#name}

      • getRuntime

        @Stability(Stable)
@NotNull
String getRuntime()
        The runtime in which the function is going to run. Eg. "nodejs12", "nodejs14", "python37", "go111".

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

      • getAvailableMemoryMb

        @Stability(Stable)
@Nullable
default Number getAvailableMemoryMb()
        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/5.43.1/docs/resources/cloudfunctions_function#available_memory_mb CloudfunctionsFunction#available_memory_mb}

      • getBuildEnvironmentVariables

        @Stability(Stable)
@Nullable
default Map<String,​String> getBuildEnvironmentVariables()
        A set of key/value environment variable pairs available during build time.

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

      • getBuildServiceAccount

        @Stability(Stable)
@Nullable
default String getBuildServiceAccount()
        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/5.43.1/docs/resources/cloudfunctions_function#build_service_account CloudfunctionsFunction#build_service_account}

      • getBuildWorkerPool

        @Stability(Stable)
@Nullable
default String getBuildWorkerPool()
        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/5.43.1/docs/resources/cloudfunctions_function#build_worker_pool CloudfunctionsFunction#build_worker_pool}

      • getDescription

        @Stability(Stable)
@Nullable
default String getDescription()
        Description of the function.

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

      • getDockerRegistry

        @Stability(Stable)
@Nullable
default String getDockerRegistry()
        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/5.43.1/docs/resources/cloudfunctions_function#docker_registry CloudfunctionsFunction#docker_registry}

      • getDockerRepository

        @Stability(Stable)
@Nullable
default String getDockerRepository()
        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/5.43.1/docs/resources/cloudfunctions_function#docker_repository CloudfunctionsFunction#docker_repository}

      • getEntryPoint

        @Stability(Stable)
@Nullable
default String getEntryPoint()
        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/5.43.1/docs/resources/cloudfunctions_function#entry_point CloudfunctionsFunction#entry_point}

      • getEnvironmentVariables

        @Stability(Stable)
@Nullable
default Map<String,​String> getEnvironmentVariables()
        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/5.43.1/docs/resources/cloudfunctions_function#environment_variables CloudfunctionsFunction#environment_variables}

      • getEventTrigger

        @Stability(Stable)
@Nullable
default CloudfunctionsFunctionEventTrigger getEventTrigger()
        event_trigger block.

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

      • getHttpsTriggerSecurityLevel

        @Stability(Stable)
@Nullable
default String getHttpsTriggerSecurityLevel()
        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/5.43.1/docs/resources/cloudfunctions_function#https_trigger_security_level CloudfunctionsFunction#https_trigger_security_level}

      • getHttpsTriggerUrl

        @Stability(Stable)
@Nullable
default String getHttpsTriggerUrl()
        URL which triggers function execution. Returned only if trigger_http is used.

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

      • getId

        @Stability(Stable)
@Nullable
default String getId()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/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.

      • getIngressSettings

        @Stability(Stable)
@Nullable
default String getIngressSettings()
        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/5.43.1/docs/resources/cloudfunctions_function#ingress_settings CloudfunctionsFunction#ingress_settings}

      • getKmsKeyName

        @Stability(Stable)
@Nullable
default String getKmsKeyName()
        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/5.43.1/docs/resources/cloudfunctions_function#kms_key_name CloudfunctionsFunction#kms_key_name}

      • getLabels

        @Stability(Stable)
@Nullable
default Map<String,​String> getLabels()
        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/5.43.1/docs/resources/cloudfunctions_function#labels CloudfunctionsFunction#labels}

      • getMaxInstances

        @Stability(Stable)
@Nullable
default Number getMaxInstances()
        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/5.43.1/docs/resources/cloudfunctions_function#max_instances CloudfunctionsFunction#max_instances}

      • getMinInstances

        @Stability(Stable)
@Nullable
default Number getMinInstances()
        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/5.43.1/docs/resources/cloudfunctions_function#min_instances CloudfunctionsFunction#min_instances}

      • getProject

        @Stability(Stable)
@Nullable
default String getProject()
        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/5.43.1/docs/resources/cloudfunctions_function#project CloudfunctionsFunction#project}

      • getRegion

        @Stability(Stable)
@Nullable
default String getRegion()
        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/5.43.1/docs/resources/cloudfunctions_function#region CloudfunctionsFunction#region}

      • getSecretEnvironmentVariables

        @Stability(Stable)
@Nullable
default Object getSecretEnvironmentVariables()
        secret_environment_variables block.

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

      • getSecretVolumes

        @Stability(Stable)
@Nullable
default Object getSecretVolumes()
        secret_volumes block.

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

      • getServiceAccountEmail

        @Stability(Stable)
@Nullable
default String getServiceAccountEmail()
        If provided, the self-provided service account to run the function with.

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

      • getSourceArchiveBucket

        @Stability(Stable)
@Nullable
default String getSourceArchiveBucket()
        The GCS bucket containing the zip archive which contains the function.

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

      • getSourceArchiveObject

        @Stability(Stable)
@Nullable
default String getSourceArchiveObject()
        The source archive object (file) in archive bucket.

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

      • getSourceRepository

        @Stability(Stable)
@Nullable
default CloudfunctionsFunctionSourceRepository getSourceRepository()
        source_repository block.

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

      • getTimeout

        @Stability(Stable)
@Nullable
default Number getTimeout()
        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/5.43.1/docs/resources/cloudfunctions_function#timeout CloudfunctionsFunction#timeout}

      • getTimeouts

        @Stability(Stable)
@Nullable
default CloudfunctionsFunctionTimeouts getTimeouts()
        timeouts block.

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

      • getTriggerHttp

        @Stability(Stable)
@Nullable
default Object getTriggerHttp()
        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/5.43.1/docs/resources/cloudfunctions_function#trigger_http CloudfunctionsFunction#trigger_http}

      • getVpcConnector

        @Stability(Stable)
@Nullable
default String getVpcConnector()
        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/5.43.1/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.

      • getVpcConnectorEgressSettings

        @Stability(Stable)
@Nullable
default String getVpcConnectorEgressSettings()
        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/5.43.1/docs/resources/cloudfunctions_function#vpc_connector_egress_settings CloudfunctionsFunction#vpc_connector_egress_settings}