FunctionState class

Input properties used for looking up and filtering Function resources.

Constructors

FunctionState({Input<Map<String, dynamic>?>? automaticUpdatePolicy, Input<int?>? availableMemoryMb, Input<Map<String, String>?>? buildEnvironmentVariables, Input<String?>? buildServiceAccount, Input<String?>? buildWorkerPool, Input<String?>? deletionPolicy, Input<String?>? description, Input<String?>? dockerRegistry, Input<String?>? dockerRepository, Input<Map<String, String>?>? effectiveLabels, Input<String?>? entryPoint, Input<Map<String, String>?>? environmentVariables, Input<FunctionEventTrigger?>? eventTrigger, Input<String?>? httpsTriggerSecurityLevel, Input<String?>? httpsTriggerUrl, Input<String?>? ingressSettings, Input<String?>? kmsKeyName, Input<Map<String, String>?>? labels, Input<int?>? maxInstances, Input<int?>? minInstances, Input<String?>? name, Input<FunctionOnDeployUpdatePolicy?>? onDeployUpdatePolicy, Input<String?>? project, Input<Map<String, String>?>? pulumiLabels, Input<String?>? region, Input<String?>? runtime, Input<List<FunctionSecretEnvironmentVariable>?>? secretEnvironmentVariables, Input<List<FunctionSecretVolume>?>? secretVolumes, Input<String?>? serviceAccountEmail, Input<String?>? sourceArchiveBucket, Input<String?>? sourceArchiveObject, Input<FunctionSourceRepository?>? sourceRepository, Input<String?>? status, Input<int?>? timeout, Input<bool?>? triggerHttp, Input<String?>? versionId, Input<String?>? vpcConnector, Input<String?>? vpcConnectorEgressSettings})
Creates a new FunctionState. automaticUpdatePolicy Security patches are applied automatically to the runtime without requiring the function to be redeployed. This should be specified as an empty block and cannot be set alongside onDeployUpdatePolicy. availableMemoryMb Memory (in MB), available to the function. Default value is 256. Possible values include 128, 256, 512, 1024, etc. buildEnvironmentVariables A set of key/value environment variable pairs available during build time. buildServiceAccount If provided, the self-provided service account to use to build the function. The format of this field is projects/{project}/serviceAccounts/{serviceAccountEmail} buildWorkerPool Name of the Cloud Build Custom Worker Pool that should be used to build the function. deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to "DELETE". description Description of the function. dockerRegistry Docker Registry to use for storing the function's Docker images. Allowed values are ARTIFACT_REGISTRY (default) and CONTAINER_REGISTRY. dockerRepository User-managed repository created in Artifact Registry to which the function's Docker image will be pushed after it is built by Cloud Build. May optionally be encrypted with a customer-managed encryption key (CMEK). If unspecified and dockerRegistry is not explicitly set to CONTAINER_REGISTRY, GCF will create and use a default Artifact Registry repository named 'gcf-artifacts' in the region. effectiveLabels All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. entryPoint Name of the function that will be executed when the Google Cloud Function is triggered. environmentVariables A set of key/value environment variable pairs to assign to the function. eventTrigger A source that fires events in response to a condition in another service. Structure is documented below. Cannot be used with triggerHttp. httpsTriggerSecurityLevel The security level for the function. The following options are available: httpsTriggerUrl URL which triggers function execution. Returned only if triggerHttp is used. ingressSettings String value that controls what traffic can reach the function. Allowed values are ALLOW_ALL, ALLOW_INTERNAL_AND_GCLB and ALLOW_INTERNAL_ONLY. Check ingress documentation to see the impact of each settings value. Changes to this field will recreate the cloud function. kmsKeyName Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function resources. It must match the pattern projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}. labels A set of key/value label pairs to assign to the function. Label keys must follow the requirements at https://docs.cloud.google.com/resource-manager/docs/creating-managing-labels#requirements. maxInstances The limit on the maximum number of function instances that may coexist at a given time. minInstances The limit on the minimum number of function instances that may coexist at a given time. name A user-defined name of the function. Function names must be unique globally. onDeployUpdatePolicy Security patches are only applied when a function is redeployed. This should be specified as an empty block and cannot be set alongside automaticUpdatePolicy. Structure is documented below. project Project of the function. If it is not provided, the provider project is used. pulumiLabels The combination of labels configured directly on the resource and default labels configured on the provider. region Region of function. If it is not provided, the provider region is used. runtime The runtime in which the function is going to run. secretEnvironmentVariables Secret environment variables configuration. Structure is documented below. secretVolumes Secret volumes configuration. Structure is documented below. serviceAccountEmail If provided, the self-provided service account to run the function with. sourceArchiveBucket The GCS bucket containing the zip archive which contains the function. sourceArchiveObject The source archive object (file) in archive bucket. sourceRepository Represents parameters related to source repository where a function is hosted. status Describes the current stage of a deployment. timeout Timeout (in seconds) for the function. Default value is 60 seconds. Cannot be more than 540 seconds. triggerHttp 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 httpsTriggerUrl. Cannot be used with eventTrigger. versionId The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created. vpcConnector The VPC Network Connector that this cloud function can connect to. It should be set up as fully-qualified URI. The format of this field is projects/*/locations/*/connectors/*. vpcConnectorEgressSettings 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.
const
FunctionState.fromMap(Map<String, dynamic> map)
factory

Properties

automaticUpdatePolicy → Input<Map<String, dynamic>?>?
Security patches are applied automatically to the runtime without requiring the function to be redeployed. This should be specified as an empty block and cannot be set alongside onDeployUpdatePolicy.
final
availableMemoryMb → Input<int?>?
Memory (in MB), available to the function. Default value is 256. Possible values include 128, 256, 512, 1024, etc.
final
buildEnvironmentVariables → Input<Map<String, String>?>?
A set of key/value environment variable pairs available during build time.
final
buildServiceAccount → Input<String?>?
If provided, the self-provided service account to use to build the function. The format of this field is projects/{project}/serviceAccounts/{serviceAccountEmail}
final
buildWorkerPool → Input<String?>?
Name of the Cloud Build Custom Worker Pool that should be used to build the function.
final
deletionPolicy → Input<String?>?
Whether Terraform will be prevented from destroying the resource. Defaults to "DELETE". When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
final
description → Input<String?>?
Description of the function.
final
dockerRegistry → Input<String?>?
Docker Registry to use for storing the function's Docker images. Allowed values are ARTIFACT_REGISTRY (default) and CONTAINER_REGISTRY.
final
dockerRepository → Input<String?>?
User-managed repository created in Artifact Registry to which the function's Docker image will be pushed after it is built by Cloud Build. May optionally be encrypted with a customer-managed encryption key (CMEK). If unspecified and dockerRegistry is not explicitly set to CONTAINER_REGISTRY, GCF will create and use a default Artifact Registry repository named 'gcf-artifacts' in the region.
final
effectiveLabels → Input<Map<String, String>?>?
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
final
entryPoint → Input<String?>?
Name of the function that will be executed when the Google Cloud Function is triggered.
final
environmentVariables → Input<Map<String, String>?>?
A set of key/value environment variable pairs to assign to the function.
final
eventTrigger → Input<FunctionEventTrigger?>?
A source that fires events in response to a condition in another service. Structure is documented below. Cannot be used with triggerHttp.
final
hashCode → int
The hash code for this object.
no setterinherited
httpsTriggerSecurityLevel → Input<String?>?
The security level for the function. The following options are available:
final
httpsTriggerUrl → Input<String?>?
URL which triggers function execution. Returned only if triggerHttp is used.
final
ingressSettings → Input<String?>?
String value that controls what traffic can reach the function. Allowed values are ALLOW_ALL, ALLOW_INTERNAL_AND_GCLB and ALLOW_INTERNAL_ONLY. Check ingress documentation to see the impact of each settings value. Changes to this field will recreate the cloud function.
final
kmsKeyName → Input<String?>?
Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function resources. It must match the pattern projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}. If specified, you must also provide an artifact registry repository using the dockerRepository field that was created with the same KMS crypto key. Before deploying, please complete all pre-requisites described in https://cloud.google.com/functions/docs/securing/cmek#granting_service_accounts_access_to_the_key
final
labels → Input<Map<String, String>?>?
A set of key/value label pairs to assign to the function. Label keys must follow the requirements at https://docs.cloud.google.com/resource-manager/docs/creating-managing-labels#requirements.
final
maxInstances → Input<int?>?
The limit on the maximum number of function instances that may coexist at a given time.
final
minInstances → Input<int?>?
The limit on the minimum number of function instances that may coexist at a given time.
final
name → Input<String?>?
A user-defined name of the function. Function names must be unique globally.
final
onDeployUpdatePolicy → Input<FunctionOnDeployUpdatePolicy?>?
Security patches are only applied when a function is redeployed. This should be specified as an empty block and cannot be set alongside automaticUpdatePolicy. Structure is documented below.
final
project → Input<String?>?
Project of the function. If it is not provided, the provider project is used.
final
pulumiLabels → Input<Map<String, String>?>?
The combination of labels configured directly on the resource and default labels configured on the provider.
final
region → Input<String?>?
Region of function. If it is not provided, the provider region is used.
final
runtime → Input<String?>?
The runtime in which the function is going to run. Eg. "nodejs20", "python39", "dotnet3", "go116", "java11", "ruby30", "php74", etc. Check the official doc for the up-to-date list.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
secretEnvironmentVariables → Input<List<FunctionSecretEnvironmentVariable>?>?
Secret environment variables configuration. Structure is documented below.
final
secretVolumes → Input<List<FunctionSecretVolume>?>?
Secret volumes configuration. Structure is documented below.
final
serviceAccountEmail → Input<String?>?
If provided, the self-provided service account to run the function with.
final
sourceArchiveBucket → Input<String?>?
The GCS bucket containing the zip archive which contains the function.
final
sourceArchiveObject → Input<String?>?
The source archive object (file) in archive bucket.
final
sourceRepository → Input<FunctionSourceRepository?>?
Represents parameters related to source repository where a function is hosted. Cannot be set alongside sourceArchiveBucket or sourceArchiveObject. Structure is documented below. It must match the pattern projects/{project}/locations/{location}/repositories/{repository}.*
final
status → Input<String?>?
Describes the current stage of a deployment.
final
timeout → Input<int?>?
Timeout (in seconds) for the function. Default value is 60 seconds. Cannot be more than 540 seconds.
final
triggerHttp → Input<bool?>?
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 httpsTriggerUrl. Cannot be used with eventTrigger.
final
versionId → Input<String?>?
The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created.
final
vpcConnector → Input<String?>?
The VPC Network Connector that this cloud function can connect to. It should be set up as fully-qualified URI. The format of this field is projects/*/locations/*/connectors/*.
final
vpcConnectorEgressSettings → Input<String?>?
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.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited