Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
google-native.cloudfunctions/v1.getFunction
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
Returns a function with the given name from the requested project.
Using getFunction
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getFunction(args: GetFunctionArgs, opts?: InvokeOptions): Promise<GetFunctionResult>
function getFunctionOutput(args: GetFunctionOutputArgs, opts?: InvokeOptions): Output<GetFunctionResult>
def get_function(function_id: Optional[str] = None,
location: Optional[str] = None,
project: Optional[str] = None,
version_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetFunctionResult
def get_function_output(function_id: Optional[pulumi.Input[str]] = None,
location: Optional[pulumi.Input[str]] = None,
project: Optional[pulumi.Input[str]] = None,
version_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetFunctionResult]
func LookupFunction(ctx *Context, args *LookupFunctionArgs, opts ...InvokeOption) (*LookupFunctionResult, error)
func LookupFunctionOutput(ctx *Context, args *LookupFunctionOutputArgs, opts ...InvokeOption) LookupFunctionResultOutput
> Note: This function is named LookupFunction
in the Go SDK.
public static class GetFunction
{
public static Task<GetFunctionResult> InvokeAsync(GetFunctionArgs args, InvokeOptions? opts = null)
public static Output<GetFunctionResult> Invoke(GetFunctionInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetFunctionResult> getFunction(GetFunctionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: google-native:cloudfunctions/v1:getFunction
arguments:
# arguments dictionary
The following arguments are supported:
- Function
Id string - Location string
- Project string
- Version
Id string
- Function
Id string - Location string
- Project string
- Version
Id string
- function
Id String - location String
- project String
- version
Id String
- function
Id string - location string
- project string
- version
Id string
- function_
id str - location str
- project str
- version_
id str
- function
Id String - location String
- project String
- version
Id String
getFunction Result
The following output properties are available:
- Available
Memory intMb - The amount of memory in MB available for a function. Defaults to 256MB.
- Build
Environment Dictionary<string, string>Variables - Build environment variables that shall be available during build time.
- Build
Id string - The Cloud Build ID of the latest successful deployment of the function.
- Build
Name string - The Cloud Build Name of the function deployment.
projects//locations//builds/
. - Build
Worker stringPool - Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is
projects/{project}/locations/{region}/workerPools/{workerPool}
where{project}
and{region}
are the project id and region respectively where the worker pool is defined and{workerPool}
is the short name of the worker pool. If the project id is not the same as the function, then the Cloud Functions Service Agent (service-@gcf-admin-robot.iam.gserviceaccount.com
) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder
) in the project. - Description string
- User-provided description of a function.
- Docker
Registry string - Docker Registry to use for this deployment. If
docker_repository
field is specified, this field will be automatically set asARTIFACT_REGISTRY
. If unspecified, it currently defaults toCONTAINER_REGISTRY
. This field may be overridden by the backend for eligible deployments. - Docker
Repository string - User managed repository created in Artifact Registry optionally with a customer managed encryption key. If specified, deployments will use Artifact Registry. If unspecified and the deployment is eligible to use Artifact Registry, GCF will create and use a repository named 'gcf-artifacts' for every deployed region. This is the repository to which the function docker image will be pushed after it is built by Cloud Build. It must match the pattern
projects/{project}/locations/{location}/repositories/{repository}
. Cross-project repositories are not supported. Cross-location repositories are not supported. Repository format must be 'DOCKER'. - Entry
Point string - The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix (ID of the function), if not specified.
- Environment
Variables Dictionary<string, string> - Environment variables that shall be available during function execution.
- Event
Trigger Pulumi.Google Native. Cloud Functions. V1. Outputs. Event Trigger Response - A source that fires events in response to a condition in another service.
- Https
Trigger Pulumi.Google Native. Cloud Functions. V1. Outputs. Https Trigger Response - An HTTPS endpoint type of source that can be triggered via URL.
- Ingress
Settings string - The ingress settings for the function, controlling what traffic can reach it.
- Kms
Key stringName - 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 thedocker_repository
field that was created with the same KMS crypto key. The following service accounts need to be granted the role 'Cloud KMS CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter)' on the Key/KeyRing/Project/Organization (least access preferred). 1. Google Cloud Functions service account (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) - Required to protect the function's image. 2. Google Storage service account (service-{project_number}@gs-project-accounts.iam.gserviceaccount.com) - Required to protect the function's source code. If this service account does not exist, deploying a function without a KMS key or retrieving the service agent name provisions it. For more information, see https://cloud.google.com/storage/docs/projects#service-agents and https://cloud.google.com/storage/docs/getting-service-agent#gsutil. Google Cloud Functions delegates access to service agents to protect function resources in internal projects that are not accessible by the end user. - Labels Dictionary<string, string>
- Labels associated with this Cloud Function.
- Max
Instances int - The limit on the maximum number of function instances that may coexist at a given time. In some cases, such as rapid traffic surges, Cloud Functions may, for a short period of time, create more instances than the specified max instances limit. If your function cannot tolerate this temporary behavior, you may want to factor in a safety margin and set a lower max instances value than your function can tolerate. See the Max Instances Guide for more details.
- Min
Instances int - A lower bound for the number function instances that may coexist at a given time.
- Name string
- A user-defined name of the function. Function names must be unique globally and match pattern
projects/*/locations/*/functions/*
- Network string
- Deprecated: use vpc_connector
- Runtime string
- The runtime in which to run the function. Required when deploying a new function, optional when updating an existing function. For a complete list of possible choices, see the
gcloud
command reference. - Secret
Environment List<Pulumi.Variables Google Native. Cloud Functions. V1. Outputs. Secret Env Var Response> - Secret environment variables configuration.
- Secret
Volumes List<Pulumi.Google Native. Cloud Functions. V1. Outputs. Secret Volume Response> - Secret volumes configuration.
- Service
Account stringEmail - The email of the function's service account. If empty, defaults to
{project_id}@appspot.gserviceaccount.com
. - Source
Archive stringUrl - The Google Cloud Storage URL, starting with
gs://
, pointing to the zip archive which contains the function. - Source
Repository Pulumi.Google Native. Cloud Functions. V1. Outputs. Source Repository Response - Beta Feature The source repository where a function is hosted.
- Source
Token string - Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.
- Source
Upload stringUrl - The Google Cloud Storage signed URL used for source uploading, generated by calling [google.cloud.functions.v1.GenerateUploadUrl]. The signature is validated on write methods (Create, Update) The signature is stripped from the Function object on read methods (Get, List)
- Status string
- Status of the function deployment.
- Timeout string
- The function execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period. Defaults to 60 seconds.
- Update
Time string - The last update timestamp of a Cloud Function.
- Version
Id string - The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created.
- Vpc
Connector string - 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/*
This field is mutually exclusive withnetwork
field and will eventually replace it. See the VPC documentation for more information on connecting Cloud projects. - Vpc
Connector stringEgress Settings - The egress settings for the connector, controlling what traffic is diverted through it.
- Available
Memory intMb - The amount of memory in MB available for a function. Defaults to 256MB.
- Build
Environment map[string]stringVariables - Build environment variables that shall be available during build time.
- Build
Id string - The Cloud Build ID of the latest successful deployment of the function.
- Build
Name string - The Cloud Build Name of the function deployment.
projects//locations//builds/
. - Build
Worker stringPool - Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is
projects/{project}/locations/{region}/workerPools/{workerPool}
where{project}
and{region}
are the project id and region respectively where the worker pool is defined and{workerPool}
is the short name of the worker pool. If the project id is not the same as the function, then the Cloud Functions Service Agent (service-@gcf-admin-robot.iam.gserviceaccount.com
) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder
) in the project. - Description string
- User-provided description of a function.
- Docker
Registry string - Docker Registry to use for this deployment. If
docker_repository
field is specified, this field will be automatically set asARTIFACT_REGISTRY
. If unspecified, it currently defaults toCONTAINER_REGISTRY
. This field may be overridden by the backend for eligible deployments. - Docker
Repository string - User managed repository created in Artifact Registry optionally with a customer managed encryption key. If specified, deployments will use Artifact Registry. If unspecified and the deployment is eligible to use Artifact Registry, GCF will create and use a repository named 'gcf-artifacts' for every deployed region. This is the repository to which the function docker image will be pushed after it is built by Cloud Build. It must match the pattern
projects/{project}/locations/{location}/repositories/{repository}
. Cross-project repositories are not supported. Cross-location repositories are not supported. Repository format must be 'DOCKER'. - Entry
Point string - The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix (ID of the function), if not specified.
- Environment
Variables map[string]string - Environment variables that shall be available during function execution.
- Event
Trigger EventTrigger Response - A source that fires events in response to a condition in another service.
- Https
Trigger HttpsTrigger Response - An HTTPS endpoint type of source that can be triggered via URL.
- Ingress
Settings string - The ingress settings for the function, controlling what traffic can reach it.
- Kms
Key stringName - 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 thedocker_repository
field that was created with the same KMS crypto key. The following service accounts need to be granted the role 'Cloud KMS CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter)' on the Key/KeyRing/Project/Organization (least access preferred). 1. Google Cloud Functions service account (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) - Required to protect the function's image. 2. Google Storage service account (service-{project_number}@gs-project-accounts.iam.gserviceaccount.com) - Required to protect the function's source code. If this service account does not exist, deploying a function without a KMS key or retrieving the service agent name provisions it. For more information, see https://cloud.google.com/storage/docs/projects#service-agents and https://cloud.google.com/storage/docs/getting-service-agent#gsutil. Google Cloud Functions delegates access to service agents to protect function resources in internal projects that are not accessible by the end user. - Labels map[string]string
- Labels associated with this Cloud Function.
- Max
Instances int - The limit on the maximum number of function instances that may coexist at a given time. In some cases, such as rapid traffic surges, Cloud Functions may, for a short period of time, create more instances than the specified max instances limit. If your function cannot tolerate this temporary behavior, you may want to factor in a safety margin and set a lower max instances value than your function can tolerate. See the Max Instances Guide for more details.
- Min
Instances int - A lower bound for the number function instances that may coexist at a given time.
- Name string
- A user-defined name of the function. Function names must be unique globally and match pattern
projects/*/locations/*/functions/*
- Network string
- Deprecated: use vpc_connector
- Runtime string
- The runtime in which to run the function. Required when deploying a new function, optional when updating an existing function. For a complete list of possible choices, see the
gcloud
command reference. - Secret
Environment []SecretVariables Env Var Response - Secret environment variables configuration.
- Secret
Volumes []SecretVolume Response - Secret volumes configuration.
- Service
Account stringEmail - The email of the function's service account. If empty, defaults to
{project_id}@appspot.gserviceaccount.com
. - Source
Archive stringUrl - The Google Cloud Storage URL, starting with
gs://
, pointing to the zip archive which contains the function. - Source
Repository SourceRepository Response - Beta Feature The source repository where a function is hosted.
- Source
Token string - Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.
- Source
Upload stringUrl - The Google Cloud Storage signed URL used for source uploading, generated by calling [google.cloud.functions.v1.GenerateUploadUrl]. The signature is validated on write methods (Create, Update) The signature is stripped from the Function object on read methods (Get, List)
- Status string
- Status of the function deployment.
- Timeout string
- The function execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period. Defaults to 60 seconds.
- Update
Time string - The last update timestamp of a Cloud Function.
- Version
Id string - The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created.
- Vpc
Connector string - 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/*
This field is mutually exclusive withnetwork
field and will eventually replace it. See the VPC documentation for more information on connecting Cloud projects. - Vpc
Connector stringEgress Settings - The egress settings for the connector, controlling what traffic is diverted through it.
- available
Memory IntegerMb - The amount of memory in MB available for a function. Defaults to 256MB.
- build
Environment Map<String,String>Variables - Build environment variables that shall be available during build time.
- build
Id String - The Cloud Build ID of the latest successful deployment of the function.
- build
Name String - The Cloud Build Name of the function deployment.
projects//locations//builds/
. - build
Worker StringPool - Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is
projects/{project}/locations/{region}/workerPools/{workerPool}
where{project}
and{region}
are the project id and region respectively where the worker pool is defined and{workerPool}
is the short name of the worker pool. If the project id is not the same as the function, then the Cloud Functions Service Agent (service-@gcf-admin-robot.iam.gserviceaccount.com
) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder
) in the project. - description String
- User-provided description of a function.
- docker
Registry String - Docker Registry to use for this deployment. If
docker_repository
field is specified, this field will be automatically set asARTIFACT_REGISTRY
. If unspecified, it currently defaults toCONTAINER_REGISTRY
. This field may be overridden by the backend for eligible deployments. - docker
Repository String - User managed repository created in Artifact Registry optionally with a customer managed encryption key. If specified, deployments will use Artifact Registry. If unspecified and the deployment is eligible to use Artifact Registry, GCF will create and use a repository named 'gcf-artifacts' for every deployed region. This is the repository to which the function docker image will be pushed after it is built by Cloud Build. It must match the pattern
projects/{project}/locations/{location}/repositories/{repository}
. Cross-project repositories are not supported. Cross-location repositories are not supported. Repository format must be 'DOCKER'. - entry
Point String - The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix (ID of the function), if not specified.
- environment
Variables Map<String,String> - Environment variables that shall be available during function execution.
- event
Trigger EventTrigger Response - A source that fires events in response to a condition in another service.
- https
Trigger HttpsTrigger Response - An HTTPS endpoint type of source that can be triggered via URL.
- ingress
Settings String - The ingress settings for the function, controlling what traffic can reach it.
- kms
Key StringName - 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 thedocker_repository
field that was created with the same KMS crypto key. The following service accounts need to be granted the role 'Cloud KMS CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter)' on the Key/KeyRing/Project/Organization (least access preferred). 1. Google Cloud Functions service account (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) - Required to protect the function's image. 2. Google Storage service account (service-{project_number}@gs-project-accounts.iam.gserviceaccount.com) - Required to protect the function's source code. If this service account does not exist, deploying a function without a KMS key or retrieving the service agent name provisions it. For more information, see https://cloud.google.com/storage/docs/projects#service-agents and https://cloud.google.com/storage/docs/getting-service-agent#gsutil. Google Cloud Functions delegates access to service agents to protect function resources in internal projects that are not accessible by the end user. - labels Map<String,String>
- Labels associated with this Cloud Function.
- max
Instances Integer - The limit on the maximum number of function instances that may coexist at a given time. In some cases, such as rapid traffic surges, Cloud Functions may, for a short period of time, create more instances than the specified max instances limit. If your function cannot tolerate this temporary behavior, you may want to factor in a safety margin and set a lower max instances value than your function can tolerate. See the Max Instances Guide for more details.
- min
Instances Integer - A lower bound for the number function instances that may coexist at a given time.
- name String
- A user-defined name of the function. Function names must be unique globally and match pattern
projects/*/locations/*/functions/*
- network String
- Deprecated: use vpc_connector
- runtime String
- The runtime in which to run the function. Required when deploying a new function, optional when updating an existing function. For a complete list of possible choices, see the
gcloud
command reference. - secret
Environment List<SecretVariables Env Var Response> - Secret environment variables configuration.
- secret
Volumes List<SecretVolume Response> - Secret volumes configuration.
- service
Account StringEmail - The email of the function's service account. If empty, defaults to
{project_id}@appspot.gserviceaccount.com
. - source
Archive StringUrl - The Google Cloud Storage URL, starting with
gs://
, pointing to the zip archive which contains the function. - source
Repository SourceRepository Response - Beta Feature The source repository where a function is hosted.
- source
Token String - Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.
- source
Upload StringUrl - The Google Cloud Storage signed URL used for source uploading, generated by calling [google.cloud.functions.v1.GenerateUploadUrl]. The signature is validated on write methods (Create, Update) The signature is stripped from the Function object on read methods (Get, List)
- status String
- Status of the function deployment.
- timeout String
- The function execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period. Defaults to 60 seconds.
- update
Time String - The last update timestamp of a Cloud Function.
- version
Id String - The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created.
- vpc
Connector String - 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/*
This field is mutually exclusive withnetwork
field and will eventually replace it. See the VPC documentation for more information on connecting Cloud projects. - vpc
Connector StringEgress Settings - The egress settings for the connector, controlling what traffic is diverted through it.
- available
Memory numberMb - The amount of memory in MB available for a function. Defaults to 256MB.
- build
Environment {[key: string]: string}Variables - Build environment variables that shall be available during build time.
- build
Id string - The Cloud Build ID of the latest successful deployment of the function.
- build
Name string - The Cloud Build Name of the function deployment.
projects//locations//builds/
. - build
Worker stringPool - Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is
projects/{project}/locations/{region}/workerPools/{workerPool}
where{project}
and{region}
are the project id and region respectively where the worker pool is defined and{workerPool}
is the short name of the worker pool. If the project id is not the same as the function, then the Cloud Functions Service Agent (service-@gcf-admin-robot.iam.gserviceaccount.com
) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder
) in the project. - description string
- User-provided description of a function.
- docker
Registry string - Docker Registry to use for this deployment. If
docker_repository
field is specified, this field will be automatically set asARTIFACT_REGISTRY
. If unspecified, it currently defaults toCONTAINER_REGISTRY
. This field may be overridden by the backend for eligible deployments. - docker
Repository string - User managed repository created in Artifact Registry optionally with a customer managed encryption key. If specified, deployments will use Artifact Registry. If unspecified and the deployment is eligible to use Artifact Registry, GCF will create and use a repository named 'gcf-artifacts' for every deployed region. This is the repository to which the function docker image will be pushed after it is built by Cloud Build. It must match the pattern
projects/{project}/locations/{location}/repositories/{repository}
. Cross-project repositories are not supported. Cross-location repositories are not supported. Repository format must be 'DOCKER'. - entry
Point string - The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix (ID of the function), if not specified.
- environment
Variables {[key: string]: string} - Environment variables that shall be available during function execution.
- event
Trigger EventTrigger Response - A source that fires events in response to a condition in another service.
- https
Trigger HttpsTrigger Response - An HTTPS endpoint type of source that can be triggered via URL.
- ingress
Settings string - The ingress settings for the function, controlling what traffic can reach it.
- kms
Key stringName - 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 thedocker_repository
field that was created with the same KMS crypto key. The following service accounts need to be granted the role 'Cloud KMS CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter)' on the Key/KeyRing/Project/Organization (least access preferred). 1. Google Cloud Functions service account (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) - Required to protect the function's image. 2. Google Storage service account (service-{project_number}@gs-project-accounts.iam.gserviceaccount.com) - Required to protect the function's source code. If this service account does not exist, deploying a function without a KMS key or retrieving the service agent name provisions it. For more information, see https://cloud.google.com/storage/docs/projects#service-agents and https://cloud.google.com/storage/docs/getting-service-agent#gsutil. Google Cloud Functions delegates access to service agents to protect function resources in internal projects that are not accessible by the end user. - labels {[key: string]: string}
- Labels associated with this Cloud Function.
- max
Instances number - The limit on the maximum number of function instances that may coexist at a given time. In some cases, such as rapid traffic surges, Cloud Functions may, for a short period of time, create more instances than the specified max instances limit. If your function cannot tolerate this temporary behavior, you may want to factor in a safety margin and set a lower max instances value than your function can tolerate. See the Max Instances Guide for more details.
- min
Instances number - A lower bound for the number function instances that may coexist at a given time.
- name string
- A user-defined name of the function. Function names must be unique globally and match pattern
projects/*/locations/*/functions/*
- network string
- Deprecated: use vpc_connector
- runtime string
- The runtime in which to run the function. Required when deploying a new function, optional when updating an existing function. For a complete list of possible choices, see the
gcloud
command reference. - secret
Environment SecretVariables Env Var Response[] - Secret environment variables configuration.
- secret
Volumes SecretVolume Response[] - Secret volumes configuration.
- service
Account stringEmail - The email of the function's service account. If empty, defaults to
{project_id}@appspot.gserviceaccount.com
. - source
Archive stringUrl - The Google Cloud Storage URL, starting with
gs://
, pointing to the zip archive which contains the function. - source
Repository SourceRepository Response - Beta Feature The source repository where a function is hosted.
- source
Token string - Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.
- source
Upload stringUrl - The Google Cloud Storage signed URL used for source uploading, generated by calling [google.cloud.functions.v1.GenerateUploadUrl]. The signature is validated on write methods (Create, Update) The signature is stripped from the Function object on read methods (Get, List)
- status string
- Status of the function deployment.
- timeout string
- The function execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period. Defaults to 60 seconds.
- update
Time string - The last update timestamp of a Cloud Function.
- version
Id string - The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created.
- vpc
Connector string - 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/*
This field is mutually exclusive withnetwork
field and will eventually replace it. See the VPC documentation for more information on connecting Cloud projects. - vpc
Connector stringEgress Settings - The egress settings for the connector, controlling what traffic is diverted through it.
- available_
memory_ intmb - The amount of memory in MB available for a function. Defaults to 256MB.
- build_
environment_ Mapping[str, str]variables - Build environment variables that shall be available during build time.
- build_
id str - The Cloud Build ID of the latest successful deployment of the function.
- build_
name str - The Cloud Build Name of the function deployment.
projects//locations//builds/
. - build_
worker_ strpool - Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is
projects/{project}/locations/{region}/workerPools/{workerPool}
where{project}
and{region}
are the project id and region respectively where the worker pool is defined and{workerPool}
is the short name of the worker pool. If the project id is not the same as the function, then the Cloud Functions Service Agent (service-@gcf-admin-robot.iam.gserviceaccount.com
) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder
) in the project. - description str
- User-provided description of a function.
- docker_
registry str - Docker Registry to use for this deployment. If
docker_repository
field is specified, this field will be automatically set asARTIFACT_REGISTRY
. If unspecified, it currently defaults toCONTAINER_REGISTRY
. This field may be overridden by the backend for eligible deployments. - docker_
repository str - User managed repository created in Artifact Registry optionally with a customer managed encryption key. If specified, deployments will use Artifact Registry. If unspecified and the deployment is eligible to use Artifact Registry, GCF will create and use a repository named 'gcf-artifacts' for every deployed region. This is the repository to which the function docker image will be pushed after it is built by Cloud Build. It must match the pattern
projects/{project}/locations/{location}/repositories/{repository}
. Cross-project repositories are not supported. Cross-location repositories are not supported. Repository format must be 'DOCKER'. - entry_
point str - The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix (ID of the function), if not specified.
- environment_
variables Mapping[str, str] - Environment variables that shall be available during function execution.
- event_
trigger EventTrigger Response - A source that fires events in response to a condition in another service.
- https_
trigger HttpsTrigger Response - An HTTPS endpoint type of source that can be triggered via URL.
- ingress_
settings str - The ingress settings for the function, controlling what traffic can reach it.
- kms_
key_ strname - 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 thedocker_repository
field that was created with the same KMS crypto key. The following service accounts need to be granted the role 'Cloud KMS CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter)' on the Key/KeyRing/Project/Organization (least access preferred). 1. Google Cloud Functions service account (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) - Required to protect the function's image. 2. Google Storage service account (service-{project_number}@gs-project-accounts.iam.gserviceaccount.com) - Required to protect the function's source code. If this service account does not exist, deploying a function without a KMS key or retrieving the service agent name provisions it. For more information, see https://cloud.google.com/storage/docs/projects#service-agents and https://cloud.google.com/storage/docs/getting-service-agent#gsutil. Google Cloud Functions delegates access to service agents to protect function resources in internal projects that are not accessible by the end user. - labels Mapping[str, str]
- Labels associated with this Cloud Function.
- max_
instances int - The limit on the maximum number of function instances that may coexist at a given time. In some cases, such as rapid traffic surges, Cloud Functions may, for a short period of time, create more instances than the specified max instances limit. If your function cannot tolerate this temporary behavior, you may want to factor in a safety margin and set a lower max instances value than your function can tolerate. See the Max Instances Guide for more details.
- min_
instances int - A lower bound for the number function instances that may coexist at a given time.
- name str
- A user-defined name of the function. Function names must be unique globally and match pattern
projects/*/locations/*/functions/*
- network str
- Deprecated: use vpc_connector
- runtime str
- The runtime in which to run the function. Required when deploying a new function, optional when updating an existing function. For a complete list of possible choices, see the
gcloud
command reference. - secret_
environment_ Sequence[Secretvariables Env Var Response] - Secret environment variables configuration.
- secret_
volumes Sequence[SecretVolume Response] - Secret volumes configuration.
- service_
account_ stremail - The email of the function's service account. If empty, defaults to
{project_id}@appspot.gserviceaccount.com
. - source_
archive_ strurl - The Google Cloud Storage URL, starting with
gs://
, pointing to the zip archive which contains the function. - source_
repository SourceRepository Response - Beta Feature The source repository where a function is hosted.
- source_
token str - Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.
- source_
upload_ strurl - The Google Cloud Storage signed URL used for source uploading, generated by calling [google.cloud.functions.v1.GenerateUploadUrl]. The signature is validated on write methods (Create, Update) The signature is stripped from the Function object on read methods (Get, List)
- status str
- Status of the function deployment.
- timeout str
- The function execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period. Defaults to 60 seconds.
- update_
time str - The last update timestamp of a Cloud Function.
- version_
id str - The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created.
- vpc_
connector 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/*
This field is mutually exclusive withnetwork
field and will eventually replace it. See the VPC documentation for more information on connecting Cloud projects. - vpc_
connector_ stregress_ settings - The egress settings for the connector, controlling what traffic is diverted through it.
- available
Memory NumberMb - The amount of memory in MB available for a function. Defaults to 256MB.
- build
Environment Map<String>Variables - Build environment variables that shall be available during build time.
- build
Id String - The Cloud Build ID of the latest successful deployment of the function.
- build
Name String - The Cloud Build Name of the function deployment.
projects//locations//builds/
. - build
Worker StringPool - Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is
projects/{project}/locations/{region}/workerPools/{workerPool}
where{project}
and{region}
are the project id and region respectively where the worker pool is defined and{workerPool}
is the short name of the worker pool. If the project id is not the same as the function, then the Cloud Functions Service Agent (service-@gcf-admin-robot.iam.gserviceaccount.com
) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder
) in the project. - description String
- User-provided description of a function.
- docker
Registry String - Docker Registry to use for this deployment. If
docker_repository
field is specified, this field will be automatically set asARTIFACT_REGISTRY
. If unspecified, it currently defaults toCONTAINER_REGISTRY
. This field may be overridden by the backend for eligible deployments. - docker
Repository String - User managed repository created in Artifact Registry optionally with a customer managed encryption key. If specified, deployments will use Artifact Registry. If unspecified and the deployment is eligible to use Artifact Registry, GCF will create and use a repository named 'gcf-artifacts' for every deployed region. This is the repository to which the function docker image will be pushed after it is built by Cloud Build. It must match the pattern
projects/{project}/locations/{location}/repositories/{repository}
. Cross-project repositories are not supported. Cross-location repositories are not supported. Repository format must be 'DOCKER'. - entry
Point String - The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix (ID of the function), if not specified.
- environment
Variables Map<String> - Environment variables that shall be available during function execution.
- event
Trigger Property Map - A source that fires events in response to a condition in another service.
- https
Trigger Property Map - An HTTPS endpoint type of source that can be triggered via URL.
- ingress
Settings String - The ingress settings for the function, controlling what traffic can reach it.
- kms
Key StringName - 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 thedocker_repository
field that was created with the same KMS crypto key. The following service accounts need to be granted the role 'Cloud KMS CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter)' on the Key/KeyRing/Project/Organization (least access preferred). 1. Google Cloud Functions service account (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) - Required to protect the function's image. 2. Google Storage service account (service-{project_number}@gs-project-accounts.iam.gserviceaccount.com) - Required to protect the function's source code. If this service account does not exist, deploying a function without a KMS key or retrieving the service agent name provisions it. For more information, see https://cloud.google.com/storage/docs/projects#service-agents and https://cloud.google.com/storage/docs/getting-service-agent#gsutil. Google Cloud Functions delegates access to service agents to protect function resources in internal projects that are not accessible by the end user. - labels Map<String>
- Labels associated with this Cloud Function.
- max
Instances Number - The limit on the maximum number of function instances that may coexist at a given time. In some cases, such as rapid traffic surges, Cloud Functions may, for a short period of time, create more instances than the specified max instances limit. If your function cannot tolerate this temporary behavior, you may want to factor in a safety margin and set a lower max instances value than your function can tolerate. See the Max Instances Guide for more details.
- min
Instances Number - A lower bound for the number function instances that may coexist at a given time.
- name String
- A user-defined name of the function. Function names must be unique globally and match pattern
projects/*/locations/*/functions/*
- network String
- Deprecated: use vpc_connector
- runtime String
- The runtime in which to run the function. Required when deploying a new function, optional when updating an existing function. For a complete list of possible choices, see the
gcloud
command reference. - secret
Environment List<Property Map>Variables - Secret environment variables configuration.
- secret
Volumes List<Property Map> - Secret volumes configuration.
- service
Account StringEmail - The email of the function's service account. If empty, defaults to
{project_id}@appspot.gserviceaccount.com
. - source
Archive StringUrl - The Google Cloud Storage URL, starting with
gs://
, pointing to the zip archive which contains the function. - source
Repository Property Map - Beta Feature The source repository where a function is hosted.
- source
Token String - Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.
- source
Upload StringUrl - The Google Cloud Storage signed URL used for source uploading, generated by calling [google.cloud.functions.v1.GenerateUploadUrl]. The signature is validated on write methods (Create, Update) The signature is stripped from the Function object on read methods (Get, List)
- status String
- Status of the function deployment.
- timeout String
- The function execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period. Defaults to 60 seconds.
- update
Time String - The last update timestamp of a Cloud Function.
- version
Id String - The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created.
- vpc
Connector String - 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/*
This field is mutually exclusive withnetwork
field and will eventually replace it. See the VPC documentation for more information on connecting Cloud projects. - vpc
Connector StringEgress Settings - The egress settings for the connector, controlling what traffic is diverted through it.
Supporting Types
EventTriggerResponse
- Event
Type string - The type of event to observe. For example:
providers/cloud.storage/eventTypes/object.change
andproviders/cloud.pubsub/eventTypes/topic.publish
. Event types match patternproviders/*/eventTypes/*.*
. The pattern contains: 1. namespace: For example,cloud.storage
andgoogle.firebase.analytics
. 2. resource type: The type of resource on which event occurs. For example, the Google Cloud Storage API includes the typeobject
. 3. action: The action that generates the event. For example, action for a Google Cloud Storage Object is 'change'. These parts are lower case. - Failure
Policy Pulumi.Google Native. Cloud Functions. V1. Inputs. Failure Policy Response - Specifies policy for failed executions.
- Resource string
- The resource(s) from which to observe events, for example,
projects/_/buckets/myBucket
. Not all syntactically correct values are accepted by all services. For example: 1. The authorization model must support it. Google Cloud Functions only allows EventTriggers to be deployed that observe resources in the same project as theCloudFunction
. 2. The resource type must match the pattern expected for anevent_type
. For example, anEventTrigger
that has anevent_type
of "google.pubsub.topic.publish" should have a resource that matches Google Cloud Pub/Sub topics. Additionally, some services may support short names when creating anEventTrigger
. These will always be returned in the normalized "long" format. See each service's documentation for supported formats. - Service string
- The hostname of the service that should be observed. If no string is provided, the default service implementing the API will be used. For example,
storage.googleapis.com
is the default for all event types in thegoogle.storage
namespace.
- Event
Type string - The type of event to observe. For example:
providers/cloud.storage/eventTypes/object.change
andproviders/cloud.pubsub/eventTypes/topic.publish
. Event types match patternproviders/*/eventTypes/*.*
. The pattern contains: 1. namespace: For example,cloud.storage
andgoogle.firebase.analytics
. 2. resource type: The type of resource on which event occurs. For example, the Google Cloud Storage API includes the typeobject
. 3. action: The action that generates the event. For example, action for a Google Cloud Storage Object is 'change'. These parts are lower case. - Failure
Policy FailurePolicy Response - Specifies policy for failed executions.
- Resource string
- The resource(s) from which to observe events, for example,
projects/_/buckets/myBucket
. Not all syntactically correct values are accepted by all services. For example: 1. The authorization model must support it. Google Cloud Functions only allows EventTriggers to be deployed that observe resources in the same project as theCloudFunction
. 2. The resource type must match the pattern expected for anevent_type
. For example, anEventTrigger
that has anevent_type
of "google.pubsub.topic.publish" should have a resource that matches Google Cloud Pub/Sub topics. Additionally, some services may support short names when creating anEventTrigger
. These will always be returned in the normalized "long" format. See each service's documentation for supported formats. - Service string
- The hostname of the service that should be observed. If no string is provided, the default service implementing the API will be used. For example,
storage.googleapis.com
is the default for all event types in thegoogle.storage
namespace.
- event
Type String - The type of event to observe. For example:
providers/cloud.storage/eventTypes/object.change
andproviders/cloud.pubsub/eventTypes/topic.publish
. Event types match patternproviders/*/eventTypes/*.*
. The pattern contains: 1. namespace: For example,cloud.storage
andgoogle.firebase.analytics
. 2. resource type: The type of resource on which event occurs. For example, the Google Cloud Storage API includes the typeobject
. 3. action: The action that generates the event. For example, action for a Google Cloud Storage Object is 'change'. These parts are lower case. - failure
Policy FailurePolicy Response - Specifies policy for failed executions.
- resource String
- The resource(s) from which to observe events, for example,
projects/_/buckets/myBucket
. Not all syntactically correct values are accepted by all services. For example: 1. The authorization model must support it. Google Cloud Functions only allows EventTriggers to be deployed that observe resources in the same project as theCloudFunction
. 2. The resource type must match the pattern expected for anevent_type
. For example, anEventTrigger
that has anevent_type
of "google.pubsub.topic.publish" should have a resource that matches Google Cloud Pub/Sub topics. Additionally, some services may support short names when creating anEventTrigger
. These will always be returned in the normalized "long" format. See each service's documentation for supported formats. - service String
- The hostname of the service that should be observed. If no string is provided, the default service implementing the API will be used. For example,
storage.googleapis.com
is the default for all event types in thegoogle.storage
namespace.
- event
Type string - The type of event to observe. For example:
providers/cloud.storage/eventTypes/object.change
andproviders/cloud.pubsub/eventTypes/topic.publish
. Event types match patternproviders/*/eventTypes/*.*
. The pattern contains: 1. namespace: For example,cloud.storage
andgoogle.firebase.analytics
. 2. resource type: The type of resource on which event occurs. For example, the Google Cloud Storage API includes the typeobject
. 3. action: The action that generates the event. For example, action for a Google Cloud Storage Object is 'change'. These parts are lower case. - failure
Policy FailurePolicy Response - Specifies policy for failed executions.
- resource string
- The resource(s) from which to observe events, for example,
projects/_/buckets/myBucket
. Not all syntactically correct values are accepted by all services. For example: 1. The authorization model must support it. Google Cloud Functions only allows EventTriggers to be deployed that observe resources in the same project as theCloudFunction
. 2. The resource type must match the pattern expected for anevent_type
. For example, anEventTrigger
that has anevent_type
of "google.pubsub.topic.publish" should have a resource that matches Google Cloud Pub/Sub topics. Additionally, some services may support short names when creating anEventTrigger
. These will always be returned in the normalized "long" format. See each service's documentation for supported formats. - service string
- The hostname of the service that should be observed. If no string is provided, the default service implementing the API will be used. For example,
storage.googleapis.com
is the default for all event types in thegoogle.storage
namespace.
- event_
type str - The type of event to observe. For example:
providers/cloud.storage/eventTypes/object.change
andproviders/cloud.pubsub/eventTypes/topic.publish
. Event types match patternproviders/*/eventTypes/*.*
. The pattern contains: 1. namespace: For example,cloud.storage
andgoogle.firebase.analytics
. 2. resource type: The type of resource on which event occurs. For example, the Google Cloud Storage API includes the typeobject
. 3. action: The action that generates the event. For example, action for a Google Cloud Storage Object is 'change'. These parts are lower case. - failure_
policy FailurePolicy Response - Specifies policy for failed executions.
- resource str
- The resource(s) from which to observe events, for example,
projects/_/buckets/myBucket
. Not all syntactically correct values are accepted by all services. For example: 1. The authorization model must support it. Google Cloud Functions only allows EventTriggers to be deployed that observe resources in the same project as theCloudFunction
. 2. The resource type must match the pattern expected for anevent_type
. For example, anEventTrigger
that has anevent_type
of "google.pubsub.topic.publish" should have a resource that matches Google Cloud Pub/Sub topics. Additionally, some services may support short names when creating anEventTrigger
. These will always be returned in the normalized "long" format. See each service's documentation for supported formats. - service str
- The hostname of the service that should be observed. If no string is provided, the default service implementing the API will be used. For example,
storage.googleapis.com
is the default for all event types in thegoogle.storage
namespace.
- event
Type String - The type of event to observe. For example:
providers/cloud.storage/eventTypes/object.change
andproviders/cloud.pubsub/eventTypes/topic.publish
. Event types match patternproviders/*/eventTypes/*.*
. The pattern contains: 1. namespace: For example,cloud.storage
andgoogle.firebase.analytics
. 2. resource type: The type of resource on which event occurs. For example, the Google Cloud Storage API includes the typeobject
. 3. action: The action that generates the event. For example, action for a Google Cloud Storage Object is 'change'. These parts are lower case. - failure
Policy Property Map - Specifies policy for failed executions.
- resource String
- The resource(s) from which to observe events, for example,
projects/_/buckets/myBucket
. Not all syntactically correct values are accepted by all services. For example: 1. The authorization model must support it. Google Cloud Functions only allows EventTriggers to be deployed that observe resources in the same project as theCloudFunction
. 2. The resource type must match the pattern expected for anevent_type
. For example, anEventTrigger
that has anevent_type
of "google.pubsub.topic.publish" should have a resource that matches Google Cloud Pub/Sub topics. Additionally, some services may support short names when creating anEventTrigger
. These will always be returned in the normalized "long" format. See each service's documentation for supported formats. - service String
- The hostname of the service that should be observed. If no string is provided, the default service implementing the API will be used. For example,
storage.googleapis.com
is the default for all event types in thegoogle.storage
namespace.
FailurePolicyResponse
- Retry
Pulumi.
Google Native. Cloud Functions. V1. Inputs. Retry Response - If specified, then the function will be retried in case of a failure.
- Retry
Retry
Response - If specified, then the function will be retried in case of a failure.
- retry
Retry
Response - If specified, then the function will be retried in case of a failure.
- retry
Retry
Response - If specified, then the function will be retried in case of a failure.
- retry
Retry
Response - If specified, then the function will be retried in case of a failure.
- retry Property Map
- If specified, then the function will be retried in case of a failure.
HttpsTriggerResponse
- Security
Level string - The security level for the function.
- Url string
- The deployed url for the function.
- Security
Level string - The security level for the function.
- Url string
- The deployed url for the function.
- security
Level String - The security level for the function.
- url String
- The deployed url for the function.
- security
Level string - The security level for the function.
- url string
- The deployed url for the function.
- security_
level str - The security level for the function.
- url str
- The deployed url for the function.
- security
Level String - The security level for the function.
- url String
- The deployed url for the function.
SecretEnvVarResponse
- Key string
- Name of the environment variable.
- Project string
- Project identifier (preferrably project number but can also be the project ID) 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.
- Secret string
- Name of the secret in secret manager (not the full resource name).
- Version string
- 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 instances start.
- Key string
- Name of the environment variable.
- Project string
- Project identifier (preferrably project number but can also be the project ID) 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.
- Secret string
- Name of the secret in secret manager (not the full resource name).
- Version string
- 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 instances start.
- key String
- Name of the environment variable.
- project String
- Project identifier (preferrably project number but can also be the project ID) 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.
- secret String
- Name of the secret in secret manager (not the full resource name).
- version String
- 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 instances start.
- key string
- Name of the environment variable.
- project string
- Project identifier (preferrably project number but can also be the project ID) 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.
- secret string
- Name of the secret in secret manager (not the full resource name).
- version string
- 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 instances start.
- key str
- Name of the environment variable.
- project str
- Project identifier (preferrably project number but can also be the project ID) 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.
- secret str
- Name of the secret in secret manager (not the full resource name).
- version 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 instances start.
- key String
- Name of the environment variable.
- project String
- Project identifier (preferrably project number but can also be the project ID) 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.
- secret String
- Name of the secret in secret manager (not the full resource name).
- version String
- 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 instances start.
SecretVersionResponse
- Path string
- 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
. - Version string
- 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.
- Path string
- 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
. - Version string
- 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.
- path String
- 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
. - version String
- 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.
- path string
- 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
. - version string
- 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.
- path 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
. - version 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.
- path String
- 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
. - version String
- 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.
SecretVolumeResponse
- Mount
Path string - 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 - Project string
- Project identifier (preferrably project number but can also be the project ID) 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.
- Secret string
- Name of the secret in secret manager (not the full resource name).
- Versions
List<Pulumi.
Google Native. Cloud Functions. V1. Inputs. Secret Version Response> - List of secret versions to mount for this secret. If empty, the
latest
version of the secret will be made available in a file named after the secret under the mount point.
- Mount
Path string - 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 - Project string
- Project identifier (preferrably project number but can also be the project ID) 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.
- Secret string
- Name of the secret in secret manager (not the full resource name).
- Versions
[]Secret
Version Response - List of secret versions to mount for this secret. If empty, the
latest
version of the secret will be made available in a file named after the secret under the mount point.
- mount
Path String - 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 - project String
- Project identifier (preferrably project number but can also be the project ID) 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.
- secret String
- Name of the secret in secret manager (not the full resource name).
- versions
List<Secret
Version Response> - List of secret versions to mount for this secret. If empty, the
latest
version of the secret will be made available in a file named after the secret under the mount point.
- mount
Path string - 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 - project string
- Project identifier (preferrably project number but can also be the project ID) 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.
- secret string
- Name of the secret in secret manager (not the full resource name).
- versions
Secret
Version Response[] - List of secret versions to mount for this secret. If empty, the
latest
version of the secret will be made available in a file named after the secret under the mount point.
- mount_
path 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 - project str
- Project identifier (preferrably project number but can also be the project ID) 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.
- secret str
- Name of the secret in secret manager (not the full resource name).
- versions
Sequence[Secret
Version Response] - List of secret versions to mount for this secret. If empty, the
latest
version of the secret will be made available in a file named after the secret under the mount point.
- mount
Path String - 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 - project String
- Project identifier (preferrably project number but can also be the project ID) 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.
- secret String
- Name of the secret in secret manager (not the full resource name).
- versions List<Property Map>
- List of secret versions to mount for this secret. If empty, the
latest
version of the secret will be made available in a file named after the secret under the mount point.
SourceRepositoryResponse
- Deployed
Url string - The URL pointing to the hosted repository where the function were defined at the time of deployment. It always points to a specific commit in the format described above.
- Url string
- The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit:
https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*
To refer to a moveable alias (branch):https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*
In particular, to refer to HEAD usemaster
moveable alias. To refer to a specific fixed alias (tag):https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*
You may omitpaths/*
if you want to use the main directory.
- Deployed
Url string - The URL pointing to the hosted repository where the function were defined at the time of deployment. It always points to a specific commit in the format described above.
- Url string
- The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit:
https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*
To refer to a moveable alias (branch):https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*
In particular, to refer to HEAD usemaster
moveable alias. To refer to a specific fixed alias (tag):https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*
You may omitpaths/*
if you want to use the main directory.
- deployed
Url String - The URL pointing to the hosted repository where the function were defined at the time of deployment. It always points to a specific commit in the format described above.
- url String
- The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit:
https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*
To refer to a moveable alias (branch):https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*
In particular, to refer to HEAD usemaster
moveable alias. To refer to a specific fixed alias (tag):https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*
You may omitpaths/*
if you want to use the main directory.
- deployed
Url string - The URL pointing to the hosted repository where the function were defined at the time of deployment. It always points to a specific commit in the format described above.
- url string
- The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit:
https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*
To refer to a moveable alias (branch):https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*
In particular, to refer to HEAD usemaster
moveable alias. To refer to a specific fixed alias (tag):https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*
You may omitpaths/*
if you want to use the main directory.
- deployed_
url str - The URL pointing to the hosted repository where the function were defined at the time of deployment. It always points to a specific commit in the format described above.
- url str
- The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit:
https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*
To refer to a moveable alias (branch):https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*
In particular, to refer to HEAD usemaster
moveable alias. To refer to a specific fixed alias (tag):https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*
You may omitpaths/*
if you want to use the main directory.
- deployed
Url String - The URL pointing to the hosted repository where the function were defined at the time of deployment. It always points to a specific commit in the format described above.
- url String
- The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit:
https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*
To refer to a moveable alias (branch):https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*
In particular, to refer to HEAD usemaster
moveable alias. To refer to a specific fixed alias (tag):https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*
You may omitpaths/*
if you want to use the main directory.
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi