Google Cloud
Google Cloud KMS, IAM and Cloud Run provisioning through isolated OpenTofu provider sessions.
Package @sanoma-ai/connector-gcp, version 0.11.24. Its README, with how to install and connect it, is on GitHub.
Resource types, which a data file under resources/ declares: gcp.keyRing, gcp.cryptoKey, gcp.keyIamMember, gcp.serviceAccount, gcp.serviceAccountIamMember, gcp.workloadIdentityPool, gcp.workloadIdentityProvider, gcp.customRole, gcp.auditConfig, gcp.cloudRunService, gcp.cloudRunServiceIamMember.
keyRing
import
Find a kms key ring by its projects/project/locations/location/keyRings/name or its binding id and read it; gone when there is none
Input
- idstringrequired
at least 1 character
Output
- idstringrequired
at least 1 character
- gonebooleanrequired
- stateobject
Fields
- idstring | null
- locationstringrequired
The location for the KeyRing. A full list of valid locations can be found by running 'gcloud kms locations list'.
- namestringrequired
The resource name for the KeyRing.
- projectstring | null
- timeoutsobject | null
Fields
- createstring | null
- deletestring | null
- handlestring
The driver's data for the object, opaque: pass it back unchanged
read
Read a kms key ring as it is now; gone when it no longer exists
Input
- idstringrequired
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
Output
- idstringrequired
at least 1 character
- gonebooleanrequired
- stateobject
Fields
- idstring | null
- locationstringrequired
The location for the KeyRing. A full list of valid locations can be found by running 'gcloud kms locations list'.
- namestringrequired
The resource name for the KeyRing.
- projectstring | null
- timeoutsobject | null
Fields
- createstring | null
- deletestring | null
- handlestring
The driver's data for the object, opaque: pass it back unchanged
plan
Plan how apply would make a kms key ring match its declaration (or delete it, given none); nothing changes
Input
- idstring
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
- desiredrecord of any
The declared fields; a write-only one may hold a secret marker
Output
- action"none" | "create" | "update" | "replace" | "delete"required
- plannedrecord of any
- unknownstring[]required
- replacestring[]required
The fields whose change replaces the object: not empty exactly when
replace
create
Create a kms key ring as declared
Input
- desiredrecord of anyrequired
The declared fields; a write-only one may hold a secret marker
Output
- idstringrequired
at least 1 character
- stateobjectrequired
Fields
- idstring | null
- locationstringrequired
The location for the KeyRing. A full list of valid locations can be found by running 'gcloud kms locations list'.
- namestringrequired
The resource name for the KeyRing.
- projectstring | null
- timeoutsobject | null
Fields
- createstring | null
- deletestring | null
- handlestring
The driver's data for the object, opaque: pass it back unchanged
update
Change a kms key ring to match its declaration, replacing it where a field cannot change in place
Input
- idstringrequired
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
- desiredrecord of anyrequired
The declared fields; a write-only one may hold a secret marker
- expectobject
Fields
- action"none" | "create" | "update" | "replace" | "delete"required
- replacestring[]required
Output
- idstringrequired
at least 1 character
- stateobjectrequired
Fields
- idstring | null
- locationstringrequired
The location for the KeyRing. A full list of valid locations can be found by running 'gcloud kms locations list'.
- namestringrequired
The resource name for the KeyRing.
- projectstring | null
- timeoutsobject | null
Fields
- createstring | null
- deletestring | null
- handlestring
The driver's data for the object, opaque: pass it back unchanged
delete
Delete a kms key ring; done already when it is gone
Input
- idstringrequired
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
Output
- idstringrequired
at least 1 character
- gonetruerequired
cryptoKey
import
Find a kms key by its key_ring/cryptoKeys/name or its binding id and read it; gone when there is none
Input
- idstringrequired
at least 1 character
Output
- idstringrequired
at least 1 character
- gonebooleanrequired
- stateobject
Fields
- crypto_key_backendstring | null
The resource name of the backend environment associated with all CryptoKeyVersions within this CryptoKey. The resource name is in the format "projects/*/locations/*/ekmConnections/*" and only applies to "EXTERNAL_VPC" keys.
- deletion_policystring | null
Whether Terraform will be prevented from destroying the instance. Defaults to "DELETE". When a 'terraform destroy' or 'terraform apply' would delete the instance, 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.
- destroy_scheduled_durationstring | null
The period of time that versions of this key spend in the DESTROY_SCHEDULED state before transitioning to DESTROYED. If not specified at creation time, the default duration is 30 days.
- effective_labelsrecord of string | null
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Terraform, other clients and services.
- idstring | null
- import_onlyboolean | null
Whether this key may contain imported versions only.
- key_ringstringrequired
The KeyRing that this key belongs to. Format: ''projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}''.
- labelsrecord of string | null
Labels with user-defined metadata to apply to this resource. **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.
- namestringrequired
The resource name for the CryptoKey.
- primaryobject[] | null
A copy of the primary CryptoKeyVersion that will be used by cryptoKeys.encrypt when this CryptoKey is given in EncryptRequest.name. Keys with purpose ENCRYPT_DECRYPT may have a primary. For other keys, this field will be unset.
Each item
- namestring | null
- statestring | null
- purposestring | null
The immutable purpose of this CryptoKey. See the [purpose reference](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys#CryptoKeyPurpose) for possible inputs. Default value is "ENCRYPT_DECRYPT".
- rotation_periodstring | null
Every time this period passes, generate a new CryptoKeyVersion and set it as the primary. The first rotation will take place after the specified period. The rotation period has the format of a decimal number with up to 9 fractional digits, followed by the letter 's' (seconds). It must be greater than a day (ie, 86400).
- skip_initial_version_creationboolean | null
If set to true, the request will create a CryptoKey without any CryptoKeyVersions. You must use the 'google_kms_crypto_key_version' resource to create a new CryptoKeyVersion or 'google_kms_key_ring_import_job' resource to import the CryptoKeyVersion. This field is only applicable during initial CryptoKey creation.
- terraform_labelsrecord of string | null
The combination of labels configured directly on the resource and default labels configured on the provider.
- timeoutsobject | null
Fields
- createstring | null
- deletestring | null
- updatestring | null
- version_templateobject | null
A template describing settings for new crypto key versions.
Fields
- algorithmstringrequired
The algorithm to use when creating a version based on this template. See the [algorithm reference](https://cloud.google.com/kms/docs/reference/rest/v1/CryptoKeyVersionAlgorithm) for possible inputs.
- protection_levelstring | null
The protection level to use when creating a version based on this template. Possible values include "SOFTWARE", "HSM", "EXTERNAL", "EXTERNAL_VPC". Defaults to "SOFTWARE".
- algorithmstringrequired
- crypto_key_backendstring | null
- handlestring
The driver's data for the object, opaque: pass it back unchanged
read
Read a kms key as it is now; gone when it no longer exists
Input
- idstringrequired
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
Output
- idstringrequired
at least 1 character
- gonebooleanrequired
- stateobject
Fields
- crypto_key_backendstring | null
The resource name of the backend environment associated with all CryptoKeyVersions within this CryptoKey. The resource name is in the format "projects/*/locations/*/ekmConnections/*" and only applies to "EXTERNAL_VPC" keys.
- deletion_policystring | null
Whether Terraform will be prevented from destroying the instance. Defaults to "DELETE". When a 'terraform destroy' or 'terraform apply' would delete the instance, 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.
- destroy_scheduled_durationstring | null
The period of time that versions of this key spend in the DESTROY_SCHEDULED state before transitioning to DESTROYED. If not specified at creation time, the default duration is 30 days.
- effective_labelsrecord of string | null
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Terraform, other clients and services.
- idstring | null
- import_onlyboolean | null
Whether this key may contain imported versions only.
- key_ringstringrequired
The KeyRing that this key belongs to. Format: ''projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}''.
- labelsrecord of string | null
Labels with user-defined metadata to apply to this resource. **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.
- namestringrequired
The resource name for the CryptoKey.
- primaryobject[] | null
A copy of the primary CryptoKeyVersion that will be used by cryptoKeys.encrypt when this CryptoKey is given in EncryptRequest.name. Keys with purpose ENCRYPT_DECRYPT may have a primary. For other keys, this field will be unset.
Each item
- namestring | null
- statestring | null
- purposestring | null
The immutable purpose of this CryptoKey. See the [purpose reference](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys#CryptoKeyPurpose) for possible inputs. Default value is "ENCRYPT_DECRYPT".
- rotation_periodstring | null
Every time this period passes, generate a new CryptoKeyVersion and set it as the primary. The first rotation will take place after the specified period. The rotation period has the format of a decimal number with up to 9 fractional digits, followed by the letter 's' (seconds). It must be greater than a day (ie, 86400).
- skip_initial_version_creationboolean | null
If set to true, the request will create a CryptoKey without any CryptoKeyVersions. You must use the 'google_kms_crypto_key_version' resource to create a new CryptoKeyVersion or 'google_kms_key_ring_import_job' resource to import the CryptoKeyVersion. This field is only applicable during initial CryptoKey creation.
- terraform_labelsrecord of string | null
The combination of labels configured directly on the resource and default labels configured on the provider.
- timeoutsobject | null
Fields
- createstring | null
- deletestring | null
- updatestring | null
- version_templateobject | null
A template describing settings for new crypto key versions.
Fields
- algorithmstringrequired
The algorithm to use when creating a version based on this template. See the [algorithm reference](https://cloud.google.com/kms/docs/reference/rest/v1/CryptoKeyVersionAlgorithm) for possible inputs.
- protection_levelstring | null
The protection level to use when creating a version based on this template. Possible values include "SOFTWARE", "HSM", "EXTERNAL", "EXTERNAL_VPC". Defaults to "SOFTWARE".
- algorithmstringrequired
- crypto_key_backendstring | null
- handlestring
The driver's data for the object, opaque: pass it back unchanged
plan
Plan how apply would make a kms key match its declaration (or delete it, given none); nothing changes
Input
- idstring
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
- desiredrecord of any
The declared fields; a write-only one may hold a secret marker
Output
- action"none" | "create" | "update" | "replace" | "delete"required
- plannedrecord of any
- unknownstring[]required
- replacestring[]required
The fields whose change replaces the object: not empty exactly when
replace
create
Create a kms key as declared
Input
- desiredrecord of anyrequired
The declared fields; a write-only one may hold a secret marker
Output
- idstringrequired
at least 1 character
- stateobjectrequired
Fields
- crypto_key_backendstring | null
The resource name of the backend environment associated with all CryptoKeyVersions within this CryptoKey. The resource name is in the format "projects/*/locations/*/ekmConnections/*" and only applies to "EXTERNAL_VPC" keys.
- deletion_policystring | null
Whether Terraform will be prevented from destroying the instance. Defaults to "DELETE". When a 'terraform destroy' or 'terraform apply' would delete the instance, 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.
- destroy_scheduled_durationstring | null
The period of time that versions of this key spend in the DESTROY_SCHEDULED state before transitioning to DESTROYED. If not specified at creation time, the default duration is 30 days.
- effective_labelsrecord of string | null
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Terraform, other clients and services.
- idstring | null
- import_onlyboolean | null
Whether this key may contain imported versions only.
- key_ringstringrequired
The KeyRing that this key belongs to. Format: ''projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}''.
- labelsrecord of string | null
Labels with user-defined metadata to apply to this resource. **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.
- namestringrequired
The resource name for the CryptoKey.
- primaryobject[] | null
A copy of the primary CryptoKeyVersion that will be used by cryptoKeys.encrypt when this CryptoKey is given in EncryptRequest.name. Keys with purpose ENCRYPT_DECRYPT may have a primary. For other keys, this field will be unset.
Each item
- namestring | null
- statestring | null
- purposestring | null
The immutable purpose of this CryptoKey. See the [purpose reference](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys#CryptoKeyPurpose) for possible inputs. Default value is "ENCRYPT_DECRYPT".
- rotation_periodstring | null
Every time this period passes, generate a new CryptoKeyVersion and set it as the primary. The first rotation will take place after the specified period. The rotation period has the format of a decimal number with up to 9 fractional digits, followed by the letter 's' (seconds). It must be greater than a day (ie, 86400).
- skip_initial_version_creationboolean | null
If set to true, the request will create a CryptoKey without any CryptoKeyVersions. You must use the 'google_kms_crypto_key_version' resource to create a new CryptoKeyVersion or 'google_kms_key_ring_import_job' resource to import the CryptoKeyVersion. This field is only applicable during initial CryptoKey creation.
- terraform_labelsrecord of string | null
The combination of labels configured directly on the resource and default labels configured on the provider.
- timeoutsobject | null
Fields
- createstring | null
- deletestring | null
- updatestring | null
- version_templateobject | null
A template describing settings for new crypto key versions.
Fields
- algorithmstringrequired
The algorithm to use when creating a version based on this template. See the [algorithm reference](https://cloud.google.com/kms/docs/reference/rest/v1/CryptoKeyVersionAlgorithm) for possible inputs.
- protection_levelstring | null
The protection level to use when creating a version based on this template. Possible values include "SOFTWARE", "HSM", "EXTERNAL", "EXTERNAL_VPC". Defaults to "SOFTWARE".
- algorithmstringrequired
- crypto_key_backendstring | null
- handlestring
The driver's data for the object, opaque: pass it back unchanged
update
Change a kms key to match its declaration, replacing it where a field cannot change in place
Input
- idstringrequired
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
- desiredrecord of anyrequired
The declared fields; a write-only one may hold a secret marker
- expectobject
Fields
- action"none" | "create" | "update" | "replace" | "delete"required
- replacestring[]required
Output
- idstringrequired
at least 1 character
- stateobjectrequired
Fields
- crypto_key_backendstring | null
The resource name of the backend environment associated with all CryptoKeyVersions within this CryptoKey. The resource name is in the format "projects/*/locations/*/ekmConnections/*" and only applies to "EXTERNAL_VPC" keys.
- deletion_policystring | null
Whether Terraform will be prevented from destroying the instance. Defaults to "DELETE". When a 'terraform destroy' or 'terraform apply' would delete the instance, 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.
- destroy_scheduled_durationstring | null
The period of time that versions of this key spend in the DESTROY_SCHEDULED state before transitioning to DESTROYED. If not specified at creation time, the default duration is 30 days.
- effective_labelsrecord of string | null
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Terraform, other clients and services.
- idstring | null
- import_onlyboolean | null
Whether this key may contain imported versions only.
- key_ringstringrequired
The KeyRing that this key belongs to. Format: ''projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}''.
- labelsrecord of string | null
Labels with user-defined metadata to apply to this resource. **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.
- namestringrequired
The resource name for the CryptoKey.
- primaryobject[] | null
A copy of the primary CryptoKeyVersion that will be used by cryptoKeys.encrypt when this CryptoKey is given in EncryptRequest.name. Keys with purpose ENCRYPT_DECRYPT may have a primary. For other keys, this field will be unset.
Each item
- namestring | null
- statestring | null
- purposestring | null
The immutable purpose of this CryptoKey. See the [purpose reference](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys#CryptoKeyPurpose) for possible inputs. Default value is "ENCRYPT_DECRYPT".
- rotation_periodstring | null
Every time this period passes, generate a new CryptoKeyVersion and set it as the primary. The first rotation will take place after the specified period. The rotation period has the format of a decimal number with up to 9 fractional digits, followed by the letter 's' (seconds). It must be greater than a day (ie, 86400).
- skip_initial_version_creationboolean | null
If set to true, the request will create a CryptoKey without any CryptoKeyVersions. You must use the 'google_kms_crypto_key_version' resource to create a new CryptoKeyVersion or 'google_kms_key_ring_import_job' resource to import the CryptoKeyVersion. This field is only applicable during initial CryptoKey creation.
- terraform_labelsrecord of string | null
The combination of labels configured directly on the resource and default labels configured on the provider.
- timeoutsobject | null
Fields
- createstring | null
- deletestring | null
- updatestring | null
- version_templateobject | null
A template describing settings for new crypto key versions.
Fields
- algorithmstringrequired
The algorithm to use when creating a version based on this template. See the [algorithm reference](https://cloud.google.com/kms/docs/reference/rest/v1/CryptoKeyVersionAlgorithm) for possible inputs.
- protection_levelstring | null
The protection level to use when creating a version based on this template. Possible values include "SOFTWARE", "HSM", "EXTERNAL", "EXTERNAL_VPC". Defaults to "SOFTWARE".
- algorithmstringrequired
- crypto_key_backendstring | null
- handlestring
The driver's data for the object, opaque: pass it back unchanged
delete
Delete a kms key; done already when it is gone
Input
- idstringrequired
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
Output
- idstringrequired
at least 1 character
- gonetruerequired
keyIamMember
import
Find a kms key access by its crypto_key_id role member [condition title] or its binding id and read it; gone when there is none
Input
- idstringrequired
at least 1 character
Output
- idstringrequired
at least 1 character
- gonebooleanrequired
- stateobject
Fields
- crypto_key_idstringrequired
- etagstring | null
- idstring | null
- memberstringrequired
- rolestringrequired
- conditionobject | null
Fields
- descriptionstring | null
- expressionstringrequired
- titlestringrequired
- handlestring
The driver's data for the object, opaque: pass it back unchanged
read
Read a kms key access as it is now; gone when it no longer exists
Input
- idstringrequired
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
Output
- idstringrequired
at least 1 character
- gonebooleanrequired
- stateobject
Fields
- crypto_key_idstringrequired
- etagstring | null
- idstring | null
- memberstringrequired
- rolestringrequired
- conditionobject | null
Fields
- descriptionstring | null
- expressionstringrequired
- titlestringrequired
- handlestring
The driver's data for the object, opaque: pass it back unchanged
plan
Plan how apply would make a kms key access match its declaration (or delete it, given none); nothing changes
Input
- idstring
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
- desiredrecord of any
The declared fields; a write-only one may hold a secret marker
Output
- action"none" | "create" | "update" | "replace" | "delete"required
- plannedrecord of any
- unknownstring[]required
- replacestring[]required
The fields whose change replaces the object: not empty exactly when
replace
create
Create a kms key access as declared
Input
- desiredrecord of anyrequired
The declared fields; a write-only one may hold a secret marker
Output
- idstringrequired
at least 1 character
- stateobjectrequired
Fields
- crypto_key_idstringrequired
- etagstring | null
- idstring | null
- memberstringrequired
- rolestringrequired
- conditionobject | null
Fields
- descriptionstring | null
- expressionstringrequired
- titlestringrequired
- handlestring
The driver's data for the object, opaque: pass it back unchanged
update
Change a kms key access to match its declaration, replacing it where a field cannot change in place
Input
- idstringrequired
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
- desiredrecord of anyrequired
The declared fields; a write-only one may hold a secret marker
- expectobject
Fields
- action"none" | "create" | "update" | "replace" | "delete"required
- replacestring[]required
Output
- idstringrequired
at least 1 character
- stateobjectrequired
Fields
- crypto_key_idstringrequired
- etagstring | null
- idstring | null
- memberstringrequired
- rolestringrequired
- conditionobject | null
Fields
- descriptionstring | null
- expressionstringrequired
- titlestringrequired
- handlestring
The driver's data for the object, opaque: pass it back unchanged
delete
Delete a kms key access; done already when it is gone
Input
- idstringrequired
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
Output
- idstringrequired
at least 1 character
- gonetruerequired
serviceAccount
import
Find a service account by its projects/project/serviceAccounts/account_id@project.iam.gserviceaccount.com or its binding id and read it; gone when there is none
Input
- idstringrequired
at least 1 character
Output
- idstringrequired
at least 1 character
- gonebooleanrequired
- stateobject
Fields
- account_idstringrequired
The account id that is used to generate the service account email address and a stable unique id. It is unique within a project, must be 6-30 characters long, and match the regular expression [a-z]([-a-z0-9]*[a-z0-9]) to comply with RFC1035. Changing this forces a new service account to be created.
- create_ignore_already_existsboolean | null
If set to true, skip service account creation if a service account with the same email already exists.
- deletion_policystring | null
Whether Terraform will be prevented from destroying the instance. Defaults to "DELETE". When a 'terraform destroy' or 'terraform apply' would delete the instance, 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.
- descriptionstring | null
A text description of the service account. Must be less than or equal to 256 UTF-8 bytes.
- disabledboolean | null
Whether the service account is disabled. Defaults to false
- display_namestring | null
The display name for the service account. Can be updated without creating a new resource.
- emailstring | null
The e-mail address of the service account. This value should be referenced from any google_iam_policy data sources that would grant the service account privileges.
- idstring | null
- memberstring | null
The Identity of the service account in the form 'serviceAccount:{email}'. This value is often used to refer to the service account in order to grant IAM permissions.
- namestring | null
The fully-qualified name of the service account.
- projectstring | null
The ID of the project that the service account will be created in. Defaults to the provider project configuration.
- unique_idstring | null
The unique id of the service account.
- timeoutsobject | null
Fields
- createstring | null
- account_idstringrequired
- handlestring
The driver's data for the object, opaque: pass it back unchanged
read
Read a service account as it is now; gone when it no longer exists
Input
- idstringrequired
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
Output
- idstringrequired
at least 1 character
- gonebooleanrequired
- stateobject
Fields
- account_idstringrequired
The account id that is used to generate the service account email address and a stable unique id. It is unique within a project, must be 6-30 characters long, and match the regular expression [a-z]([-a-z0-9]*[a-z0-9]) to comply with RFC1035. Changing this forces a new service account to be created.
- create_ignore_already_existsboolean | null
If set to true, skip service account creation if a service account with the same email already exists.
- deletion_policystring | null
Whether Terraform will be prevented from destroying the instance. Defaults to "DELETE". When a 'terraform destroy' or 'terraform apply' would delete the instance, 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.
- descriptionstring | null
A text description of the service account. Must be less than or equal to 256 UTF-8 bytes.
- disabledboolean | null
Whether the service account is disabled. Defaults to false
- display_namestring | null
The display name for the service account. Can be updated without creating a new resource.
- emailstring | null
The e-mail address of the service account. This value should be referenced from any google_iam_policy data sources that would grant the service account privileges.
- idstring | null
- memberstring | null
The Identity of the service account in the form 'serviceAccount:{email}'. This value is often used to refer to the service account in order to grant IAM permissions.
- namestring | null
The fully-qualified name of the service account.
- projectstring | null
The ID of the project that the service account will be created in. Defaults to the provider project configuration.
- unique_idstring | null
The unique id of the service account.
- timeoutsobject | null
Fields
- createstring | null
- account_idstringrequired
- handlestring
The driver's data for the object, opaque: pass it back unchanged
plan
Plan how apply would make a service account match its declaration (or delete it, given none); nothing changes
Input
- idstring
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
- desiredrecord of any
The declared fields; a write-only one may hold a secret marker
Output
- action"none" | "create" | "update" | "replace" | "delete"required
- plannedrecord of any
- unknownstring[]required
- replacestring[]required
The fields whose change replaces the object: not empty exactly when
replace
create
Create a service account as declared
Input
- desiredrecord of anyrequired
The declared fields; a write-only one may hold a secret marker
Output
- idstringrequired
at least 1 character
- stateobjectrequired
Fields
- account_idstringrequired
The account id that is used to generate the service account email address and a stable unique id. It is unique within a project, must be 6-30 characters long, and match the regular expression [a-z]([-a-z0-9]*[a-z0-9]) to comply with RFC1035. Changing this forces a new service account to be created.
- create_ignore_already_existsboolean | null
If set to true, skip service account creation if a service account with the same email already exists.
- deletion_policystring | null
Whether Terraform will be prevented from destroying the instance. Defaults to "DELETE". When a 'terraform destroy' or 'terraform apply' would delete the instance, 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.
- descriptionstring | null
A text description of the service account. Must be less than or equal to 256 UTF-8 bytes.
- disabledboolean | null
Whether the service account is disabled. Defaults to false
- display_namestring | null
The display name for the service account. Can be updated without creating a new resource.
- emailstring | null
The e-mail address of the service account. This value should be referenced from any google_iam_policy data sources that would grant the service account privileges.
- idstring | null
- memberstring | null
The Identity of the service account in the form 'serviceAccount:{email}'. This value is often used to refer to the service account in order to grant IAM permissions.
- namestring | null
The fully-qualified name of the service account.
- projectstring | null
The ID of the project that the service account will be created in. Defaults to the provider project configuration.
- unique_idstring | null
The unique id of the service account.
- timeoutsobject | null
Fields
- createstring | null
- account_idstringrequired
- handlestring
The driver's data for the object, opaque: pass it back unchanged
update
Change a service account to match its declaration, replacing it where a field cannot change in place
Input
- idstringrequired
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
- desiredrecord of anyrequired
The declared fields; a write-only one may hold a secret marker
- expectobject
Fields
- action"none" | "create" | "update" | "replace" | "delete"required
- replacestring[]required
Output
- idstringrequired
at least 1 character
- stateobjectrequired
Fields
- account_idstringrequired
The account id that is used to generate the service account email address and a stable unique id. It is unique within a project, must be 6-30 characters long, and match the regular expression [a-z]([-a-z0-9]*[a-z0-9]) to comply with RFC1035. Changing this forces a new service account to be created.
- create_ignore_already_existsboolean | null
If set to true, skip service account creation if a service account with the same email already exists.
- deletion_policystring | null
Whether Terraform will be prevented from destroying the instance. Defaults to "DELETE". When a 'terraform destroy' or 'terraform apply' would delete the instance, 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.
- descriptionstring | null
A text description of the service account. Must be less than or equal to 256 UTF-8 bytes.
- disabledboolean | null
Whether the service account is disabled. Defaults to false
- display_namestring | null
The display name for the service account. Can be updated without creating a new resource.
- emailstring | null
The e-mail address of the service account. This value should be referenced from any google_iam_policy data sources that would grant the service account privileges.
- idstring | null
- memberstring | null
The Identity of the service account in the form 'serviceAccount:{email}'. This value is often used to refer to the service account in order to grant IAM permissions.
- namestring | null
The fully-qualified name of the service account.
- projectstring | null
The ID of the project that the service account will be created in. Defaults to the provider project configuration.
- unique_idstring | null
The unique id of the service account.
- timeoutsobject | null
Fields
- createstring | null
- account_idstringrequired
- handlestring
The driver's data for the object, opaque: pass it back unchanged
delete
Delete a service account; done already when it is gone
Input
- idstringrequired
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
Output
- idstringrequired
at least 1 character
- gonetruerequired
serviceAccountIamMember
import
Find a service account access by its service_account_id role member [condition title] or its binding id and read it; gone when there is none
Input
- idstringrequired
at least 1 character
Output
- idstringrequired
at least 1 character
- gonebooleanrequired
- stateobject
Fields
- etagstring | null
- idstring | null
- memberstringrequired
- rolestringrequired
- service_account_idstringrequired
- conditionobject | null
Fields
- descriptionstring | null
- expressionstringrequired
- titlestringrequired
- handlestring
The driver's data for the object, opaque: pass it back unchanged
read
Read a service account access as it is now; gone when it no longer exists
Input
- idstringrequired
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
Output
- idstringrequired
at least 1 character
- gonebooleanrequired
- stateobject
Fields
- etagstring | null
- idstring | null
- memberstringrequired
- rolestringrequired
- service_account_idstringrequired
- conditionobject | null
Fields
- descriptionstring | null
- expressionstringrequired
- titlestringrequired
- handlestring
The driver's data for the object, opaque: pass it back unchanged
plan
Plan how apply would make a service account access match its declaration (or delete it, given none); nothing changes
Input
- idstring
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
- desiredrecord of any
The declared fields; a write-only one may hold a secret marker
Output
- action"none" | "create" | "update" | "replace" | "delete"required
- plannedrecord of any
- unknownstring[]required
- replacestring[]required
The fields whose change replaces the object: not empty exactly when
replace
create
Create a service account access as declared
Input
- desiredrecord of anyrequired
The declared fields; a write-only one may hold a secret marker
Output
- idstringrequired
at least 1 character
- stateobjectrequired
Fields
- etagstring | null
- idstring | null
- memberstringrequired
- rolestringrequired
- service_account_idstringrequired
- conditionobject | null
Fields
- descriptionstring | null
- expressionstringrequired
- titlestringrequired
- handlestring
The driver's data for the object, opaque: pass it back unchanged
update
Change a service account access to match its declaration, replacing it where a field cannot change in place
Input
- idstringrequired
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
- desiredrecord of anyrequired
The declared fields; a write-only one may hold a secret marker
- expectobject
Fields
- action"none" | "create" | "update" | "replace" | "delete"required
- replacestring[]required
Output
- idstringrequired
at least 1 character
- stateobjectrequired
Fields
- etagstring | null
- idstring | null
- memberstringrequired
- rolestringrequired
- service_account_idstringrequired
- conditionobject | null
Fields
- descriptionstring | null
- expressionstringrequired
- titlestringrequired
- handlestring
The driver's data for the object, opaque: pass it back unchanged
delete
Delete a service account access; done already when it is gone
Input
- idstringrequired
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
Output
- idstringrequired
at least 1 character
- gonetruerequired
workloadIdentityPool
import
Find a workload identity pool by its projects/project/locations/global/workloadIdentityPools/workload_identity_pool_id or its binding id and read it; gone when there is none
Input
- idstringrequired
at least 1 character
Output
- idstringrequired
at least 1 character
- gonebooleanrequired
- stateobject
Fields
- deletion_policystring | null
Whether Terraform will be prevented from destroying the instance. Defaults to "DELETE". When a 'terraform destroy' or 'terraform apply' would delete the instance, 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.
- descriptionstring | null
A description of the pool. Cannot exceed 256 characters.
- disabledboolean | null
Whether the pool is disabled. You cannot use a disabled pool to exchange tokens, or use existing tokens to access resources. If the pool is re-enabled, existing tokens grant access again.
- display_namestring | null
A display name for the pool. Cannot exceed 32 characters.
- idstring | null
- modestring | null
The mode for the pool is operating in. Pools with an unspecified mode will operate as if they are in 'FEDERATION_ONLY' mode. ~> **Note** This field cannot be changed after the Workload Identity Pool is created. While 'terraform plan' may show an update if you change this field's value, 'terraform apply' **will fail with an API error** (such as 'Error 400: Attempted to update an immutable field.'). To specify a different 'mode', please create a new Workload Identity Pool resource. * 'FEDERATION_ONLY': Pools can only be used for federating external workload identities into Google Cloud. Unless otherwise noted, no structure or format constraints are applied to workload identities in a 'FEDERATION_ONLY' mode pool, and you may not create any resources within the pool besides providers. * 'TRUST_DOMAIN': Pools can be used to assign identities to Google Cloud workloads. All identities within a 'TRUST_DOMAIN' mode pool must consist of a single namespace and individual workload identifier. The subject identifier for all identities must conform to the following format: 'ns/<namespace>/sa/<workload_identifier>'. 'google_iam_workload_identity_pool_provider's cannot be created within 'TRUST_DOMAIN' mode pools. * 'SYSTEM_TRUST_DOMAIN': Pools are managed by Google Cloud services. Neither 'google_iam_workload_identity_pool_namespace's nor 'google_iam_workload_identity_pool_provider's can be created within 'SYSTEM_TRUST_DOMAIN' mode pools. All identities within a 'SYSTEM_TRUST_DOMAIN' mode pool are in one of the following formats: * 'spiffe://<trust-domain>/ns/<kubernetes-namespace>/sa/<kubernetes-service-account>' * 'spiffe://<trust-domain>/resources/<resource-scope>/<resource-name>' Possible values: ["FEDERATION_ONLY", "TRUST_DOMAIN", "SYSTEM_TRUST_DOMAIN"]
- namestring | null
The resource name of the pool as 'projects/{project_number}/locations/global/workloadIdentityPools/{workload_identity_pool_id}'.
- projectstring | null
- statestring | null
The state of the pool. * 'STATE_UNSPECIFIED': State unspecified. * 'ACTIVE': The pool is active, and may be used in Google Cloud policies. * 'DELETED': The pool is soft-deleted. Soft-deleted pools are permanently deleted after approximately 30 days. You can restore a soft-deleted pool using 'UndeleteWorkloadIdentityPool'. You cannot reuse the ID of a soft-deleted pool until it is permanently deleted. While a pool is deleted, you cannot use it to exchange tokens, or use existing tokens to access resources. If the pool is undeleted, existing tokens grant access again.
- workload_identity_pool_idstringrequired
The ID to use for the pool, which becomes the final component of the resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix 'gcp-' is reserved for use by Google, and may not be specified.
- attestation_rulesobject[] | null
Defines which workloads can receive an identity within a pool. When an AttestationRule is defined under a managed identity, matching workloads may receive that identity. A maximum of 50 AttestationRules can be set.
Each item
- google_cloud_resourcestringrequired
A single workload operating on Google Cloud. For example: '//run.googleapis.com/projects/123/type/Service/*'.
- google_cloud_resourcestringrequired
- inline_certificate_issuance_configobject | null
Represents configuration for generating mutual TLS (mTLS) certificates for the identities within this pool. Defines the Certificate Authority (CA) pool resources and configurations required for issuance and rotation of mTLS workload certificates.
Fields
- ca_poolsrecord of string | null
A required mapping of a cloud region to the CA pool resource located in that region used for certificate issuance, adhering to these constraints: * **Key format:** A supported cloud region name equivalent to the location identifier in the corresponding map entry's value. * **Value format:** A valid CA pool resource path format like: 'projects/{project}/locations/{location}/caPools/{ca_pool}' * **Region Matching:** Workloads are ONLY issued certificates from CA pools within the same region. Also the CA pool region (in value) must match the workload's region (key).
- key_algorithmstring | null
Key algorithm to use when generating the key pair. This key pair will be used to create the certificate. If unspecified, this will default to 'ECDSA_P256'. * 'RSA_2048': Specifies RSA with a 2048-bit modulus. * 'RSA_3072': Specifies RSA with a 3072-bit modulus. * 'RSA_4096': Specifies RSA with a 4096-bit modulus. * 'ECDSA_P256': Specifies ECDSA with curve P256. * 'ECDSA_P384': Specifies ECDSA with curve P384. Possible values: ["RSA_2048", "RSA_3072", "RSA_4096", "ECDSA_P256", "ECDSA_P384"]
- lifetimestring | null
Lifetime of the workload certificates issued by the CA pool in seconds. Must be between '86400s' (24 hours) to '2592000s' (30 days), ends in the suffix "'s'" (indicating seconds) and is preceded by the number of seconds. If unspecified, this will be defaulted to '86400s' (24 hours).
- rotation_window_percentagenumber | null
Rotation window percentage indicating when certificate rotation should be initiated based on remaining lifetime. Must be between '50' - '80'. If unspecified, this will be defaulted to '50'.
- use_default_shared_caboolean | null
If set to true, the trust domain will utilize the GCP-provisioned default CA. A default CA in the same region as the workload will be selected to issue the certificate. Enabling this will clear any existing 'ca_pools' configuration to provision the certificates. ~> **Note** This field is mutually exclusive with 'ca_pools'. If this flag is enabled, certificates will be automatically provisioned from the default shared CAs. This flag should not be set if you want to use your own CA pools to provision the certificates.
- ca_poolsrecord of string | null
- inline_trust_configobject | null
Represents config to add additional trusted trust domains. Defines configuration for extending trust to additional trust domains. By establishing trust with another domain, the current domain will recognize and accept certificates issued by entities within the trusted domains. Note that a trust domain automatically trusts itself, eliminating the need for explicit configuration.
Fields
- additional_trust_bundlesobject[] | null
Maps specific trust domains (e.g., "example.com") to their corresponding 'TrustStore' objects, which contain the trusted root certificates for that domain. There can be a maximum of '10' trust domain entries in this map. Note that a trust domain automatically trusts itself and don't need to be specified here. If however, this 'WorkloadIdentityPool''s trust domain contains any trust anchors in the 'additional_trust_bundles' map, those trust anchors will be *appended to* the Trust Bundle automatically derived from your 'InlineCertificateIssuanceConfig''s 'ca_pools'.
Each item
- trust_default_shared_caboolean | null
If set to True, the trust bundle will include the private ca managed identity regional root public certificates. ~> **Note** 'trust_default_shared_ca' is only supported for managed identity trust domain resource.
- trust_domainstringrequired
- trust_anchorsobject[]required
List of Trust Anchors to be used while performing validation against a given 'TrustStore'. The incoming end entity's certificate must be chained up to one of the trust anchors here.
at least 1 item
Each item
- pem_certificatestringrequired
PEM certificate of the PKI used for validation. Must only contain one ca certificate(either root or intermediate cert).
- pem_certificatestringrequired
- trust_default_shared_caboolean | null
- additional_trust_bundlesobject[] | null
- timeoutsobject | null
Fields
- createstring | null
- deletestring | null
- updatestring | null
- deletion_policystring | null
- handlestring
The driver's data for the object, opaque: pass it back unchanged
read
Read a workload identity pool as it is now; gone when it no longer exists
Input
- idstringrequired
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
Output
- idstringrequired
at least 1 character
- gonebooleanrequired
- stateobject
Fields
- deletion_policystring | null
Whether Terraform will be prevented from destroying the instance. Defaults to "DELETE". When a 'terraform destroy' or 'terraform apply' would delete the instance, 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.
- descriptionstring | null
A description of the pool. Cannot exceed 256 characters.
- disabledboolean | null
Whether the pool is disabled. You cannot use a disabled pool to exchange tokens, or use existing tokens to access resources. If the pool is re-enabled, existing tokens grant access again.
- display_namestring | null
A display name for the pool. Cannot exceed 32 characters.
- idstring | null
- modestring | null
The mode for the pool is operating in. Pools with an unspecified mode will operate as if they are in 'FEDERATION_ONLY' mode. ~> **Note** This field cannot be changed after the Workload Identity Pool is created. While 'terraform plan' may show an update if you change this field's value, 'terraform apply' **will fail with an API error** (such as 'Error 400: Attempted to update an immutable field.'). To specify a different 'mode', please create a new Workload Identity Pool resource. * 'FEDERATION_ONLY': Pools can only be used for federating external workload identities into Google Cloud. Unless otherwise noted, no structure or format constraints are applied to workload identities in a 'FEDERATION_ONLY' mode pool, and you may not create any resources within the pool besides providers. * 'TRUST_DOMAIN': Pools can be used to assign identities to Google Cloud workloads. All identities within a 'TRUST_DOMAIN' mode pool must consist of a single namespace and individual workload identifier. The subject identifier for all identities must conform to the following format: 'ns/<namespace>/sa/<workload_identifier>'. 'google_iam_workload_identity_pool_provider's cannot be created within 'TRUST_DOMAIN' mode pools. * 'SYSTEM_TRUST_DOMAIN': Pools are managed by Google Cloud services. Neither 'google_iam_workload_identity_pool_namespace's nor 'google_iam_workload_identity_pool_provider's can be created within 'SYSTEM_TRUST_DOMAIN' mode pools. All identities within a 'SYSTEM_TRUST_DOMAIN' mode pool are in one of the following formats: * 'spiffe://<trust-domain>/ns/<kubernetes-namespace>/sa/<kubernetes-service-account>' * 'spiffe://<trust-domain>/resources/<resource-scope>/<resource-name>' Possible values: ["FEDERATION_ONLY", "TRUST_DOMAIN", "SYSTEM_TRUST_DOMAIN"]
- namestring | null
The resource name of the pool as 'projects/{project_number}/locations/global/workloadIdentityPools/{workload_identity_pool_id}'.
- projectstring | null
- statestring | null
The state of the pool. * 'STATE_UNSPECIFIED': State unspecified. * 'ACTIVE': The pool is active, and may be used in Google Cloud policies. * 'DELETED': The pool is soft-deleted. Soft-deleted pools are permanently deleted after approximately 30 days. You can restore a soft-deleted pool using 'UndeleteWorkloadIdentityPool'. You cannot reuse the ID of a soft-deleted pool until it is permanently deleted. While a pool is deleted, you cannot use it to exchange tokens, or use existing tokens to access resources. If the pool is undeleted, existing tokens grant access again.
- workload_identity_pool_idstringrequired
The ID to use for the pool, which becomes the final component of the resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix 'gcp-' is reserved for use by Google, and may not be specified.
- attestation_rulesobject[] | null
Defines which workloads can receive an identity within a pool. When an AttestationRule is defined under a managed identity, matching workloads may receive that identity. A maximum of 50 AttestationRules can be set.
Each item
- google_cloud_resourcestringrequired
A single workload operating on Google Cloud. For example: '//run.googleapis.com/projects/123/type/Service/*'.
- google_cloud_resourcestringrequired
- inline_certificate_issuance_configobject | null
Represents configuration for generating mutual TLS (mTLS) certificates for the identities within this pool. Defines the Certificate Authority (CA) pool resources and configurations required for issuance and rotation of mTLS workload certificates.
Fields
- ca_poolsrecord of string | null
A required mapping of a cloud region to the CA pool resource located in that region used for certificate issuance, adhering to these constraints: * **Key format:** A supported cloud region name equivalent to the location identifier in the corresponding map entry's value. * **Value format:** A valid CA pool resource path format like: 'projects/{project}/locations/{location}/caPools/{ca_pool}' * **Region Matching:** Workloads are ONLY issued certificates from CA pools within the same region. Also the CA pool region (in value) must match the workload's region (key).
- key_algorithmstring | null
Key algorithm to use when generating the key pair. This key pair will be used to create the certificate. If unspecified, this will default to 'ECDSA_P256'. * 'RSA_2048': Specifies RSA with a 2048-bit modulus. * 'RSA_3072': Specifies RSA with a 3072-bit modulus. * 'RSA_4096': Specifies RSA with a 4096-bit modulus. * 'ECDSA_P256': Specifies ECDSA with curve P256. * 'ECDSA_P384': Specifies ECDSA with curve P384. Possible values: ["RSA_2048", "RSA_3072", "RSA_4096", "ECDSA_P256", "ECDSA_P384"]
- lifetimestring | null
Lifetime of the workload certificates issued by the CA pool in seconds. Must be between '86400s' (24 hours) to '2592000s' (30 days), ends in the suffix "'s'" (indicating seconds) and is preceded by the number of seconds. If unspecified, this will be defaulted to '86400s' (24 hours).
- rotation_window_percentagenumber | null
Rotation window percentage indicating when certificate rotation should be initiated based on remaining lifetime. Must be between '50' - '80'. If unspecified, this will be defaulted to '50'.
- use_default_shared_caboolean | null
If set to true, the trust domain will utilize the GCP-provisioned default CA. A default CA in the same region as the workload will be selected to issue the certificate. Enabling this will clear any existing 'ca_pools' configuration to provision the certificates. ~> **Note** This field is mutually exclusive with 'ca_pools'. If this flag is enabled, certificates will be automatically provisioned from the default shared CAs. This flag should not be set if you want to use your own CA pools to provision the certificates.
- ca_poolsrecord of string | null
- inline_trust_configobject | null
Represents config to add additional trusted trust domains. Defines configuration for extending trust to additional trust domains. By establishing trust with another domain, the current domain will recognize and accept certificates issued by entities within the trusted domains. Note that a trust domain automatically trusts itself, eliminating the need for explicit configuration.
Fields
- additional_trust_bundlesobject[] | null
Maps specific trust domains (e.g., "example.com") to their corresponding 'TrustStore' objects, which contain the trusted root certificates for that domain. There can be a maximum of '10' trust domain entries in this map. Note that a trust domain automatically trusts itself and don't need to be specified here. If however, this 'WorkloadIdentityPool''s trust domain contains any trust anchors in the 'additional_trust_bundles' map, those trust anchors will be *appended to* the Trust Bundle automatically derived from your 'InlineCertificateIssuanceConfig''s 'ca_pools'.
Each item
- trust_default_shared_caboolean | null
If set to True, the trust bundle will include the private ca managed identity regional root public certificates. ~> **Note** 'trust_default_shared_ca' is only supported for managed identity trust domain resource.
- trust_domainstringrequired
- trust_anchorsobject[]required
List of Trust Anchors to be used while performing validation against a given 'TrustStore'. The incoming end entity's certificate must be chained up to one of the trust anchors here.
at least 1 item
Each item
- pem_certificatestringrequired
PEM certificate of the PKI used for validation. Must only contain one ca certificate(either root or intermediate cert).
- pem_certificatestringrequired
- trust_default_shared_caboolean | null
- additional_trust_bundlesobject[] | null
- timeoutsobject | null
Fields
- createstring | null
- deletestring | null
- updatestring | null
- deletion_policystring | null
- handlestring
The driver's data for the object, opaque: pass it back unchanged
plan
Plan how apply would make a workload identity pool match its declaration (or delete it, given none); nothing changes
Input
- idstring
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
- desiredrecord of any
The declared fields; a write-only one may hold a secret marker
Output
- action"none" | "create" | "update" | "replace" | "delete"required
- plannedrecord of any
- unknownstring[]required
- replacestring[]required
The fields whose change replaces the object: not empty exactly when
replace
create
Create a workload identity pool as declared
Input
- desiredrecord of anyrequired
The declared fields; a write-only one may hold a secret marker
Output
- idstringrequired
at least 1 character
- stateobjectrequired
Fields
- deletion_policystring | null
Whether Terraform will be prevented from destroying the instance. Defaults to "DELETE". When a 'terraform destroy' or 'terraform apply' would delete the instance, 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.
- descriptionstring | null
A description of the pool. Cannot exceed 256 characters.
- disabledboolean | null
Whether the pool is disabled. You cannot use a disabled pool to exchange tokens, or use existing tokens to access resources. If the pool is re-enabled, existing tokens grant access again.
- display_namestring | null
A display name for the pool. Cannot exceed 32 characters.
- idstring | null
- modestring | null
The mode for the pool is operating in. Pools with an unspecified mode will operate as if they are in 'FEDERATION_ONLY' mode. ~> **Note** This field cannot be changed after the Workload Identity Pool is created. While 'terraform plan' may show an update if you change this field's value, 'terraform apply' **will fail with an API error** (such as 'Error 400: Attempted to update an immutable field.'). To specify a different 'mode', please create a new Workload Identity Pool resource. * 'FEDERATION_ONLY': Pools can only be used for federating external workload identities into Google Cloud. Unless otherwise noted, no structure or format constraints are applied to workload identities in a 'FEDERATION_ONLY' mode pool, and you may not create any resources within the pool besides providers. * 'TRUST_DOMAIN': Pools can be used to assign identities to Google Cloud workloads. All identities within a 'TRUST_DOMAIN' mode pool must consist of a single namespace and individual workload identifier. The subject identifier for all identities must conform to the following format: 'ns/<namespace>/sa/<workload_identifier>'. 'google_iam_workload_identity_pool_provider's cannot be created within 'TRUST_DOMAIN' mode pools. * 'SYSTEM_TRUST_DOMAIN': Pools are managed by Google Cloud services. Neither 'google_iam_workload_identity_pool_namespace's nor 'google_iam_workload_identity_pool_provider's can be created within 'SYSTEM_TRUST_DOMAIN' mode pools. All identities within a 'SYSTEM_TRUST_DOMAIN' mode pool are in one of the following formats: * 'spiffe://<trust-domain>/ns/<kubernetes-namespace>/sa/<kubernetes-service-account>' * 'spiffe://<trust-domain>/resources/<resource-scope>/<resource-name>' Possible values: ["FEDERATION_ONLY", "TRUST_DOMAIN", "SYSTEM_TRUST_DOMAIN"]
- namestring | null
The resource name of the pool as 'projects/{project_number}/locations/global/workloadIdentityPools/{workload_identity_pool_id}'.
- projectstring | null
- statestring | null
The state of the pool. * 'STATE_UNSPECIFIED': State unspecified. * 'ACTIVE': The pool is active, and may be used in Google Cloud policies. * 'DELETED': The pool is soft-deleted. Soft-deleted pools are permanently deleted after approximately 30 days. You can restore a soft-deleted pool using 'UndeleteWorkloadIdentityPool'. You cannot reuse the ID of a soft-deleted pool until it is permanently deleted. While a pool is deleted, you cannot use it to exchange tokens, or use existing tokens to access resources. If the pool is undeleted, existing tokens grant access again.
- workload_identity_pool_idstringrequired
The ID to use for the pool, which becomes the final component of the resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix 'gcp-' is reserved for use by Google, and may not be specified.
- attestation_rulesobject[] | null
Defines which workloads can receive an identity within a pool. When an AttestationRule is defined under a managed identity, matching workloads may receive that identity. A maximum of 50 AttestationRules can be set.
Each item
- google_cloud_resourcestringrequired
A single workload operating on Google Cloud. For example: '//run.googleapis.com/projects/123/type/Service/*'.
- google_cloud_resourcestringrequired
- inline_certificate_issuance_configobject | null
Represents configuration for generating mutual TLS (mTLS) certificates for the identities within this pool. Defines the Certificate Authority (CA) pool resources and configurations required for issuance and rotation of mTLS workload certificates.
Fields
- ca_poolsrecord of string | null
A required mapping of a cloud region to the CA pool resource located in that region used for certificate issuance, adhering to these constraints: * **Key format:** A supported cloud region name equivalent to the location identifier in the corresponding map entry's value. * **Value format:** A valid CA pool resource path format like: 'projects/{project}/locations/{location}/caPools/{ca_pool}' * **Region Matching:** Workloads are ONLY issued certificates from CA pools within the same region. Also the CA pool region (in value) must match the workload's region (key).
- key_algorithmstring | null
Key algorithm to use when generating the key pair. This key pair will be used to create the certificate. If unspecified, this will default to 'ECDSA_P256'. * 'RSA_2048': Specifies RSA with a 2048-bit modulus. * 'RSA_3072': Specifies RSA with a 3072-bit modulus. * 'RSA_4096': Specifies RSA with a 4096-bit modulus. * 'ECDSA_P256': Specifies ECDSA with curve P256. * 'ECDSA_P384': Specifies ECDSA with curve P384. Possible values: ["RSA_2048", "RSA_3072", "RSA_4096", "ECDSA_P256", "ECDSA_P384"]
- lifetimestring | null
Lifetime of the workload certificates issued by the CA pool in seconds. Must be between '86400s' (24 hours) to '2592000s' (30 days), ends in the suffix "'s'" (indicating seconds) and is preceded by the number of seconds. If unspecified, this will be defaulted to '86400s' (24 hours).
- rotation_window_percentagenumber | null
Rotation window percentage indicating when certificate rotation should be initiated based on remaining lifetime. Must be between '50' - '80'. If unspecified, this will be defaulted to '50'.
- use_default_shared_caboolean | null
If set to true, the trust domain will utilize the GCP-provisioned default CA. A default CA in the same region as the workload will be selected to issue the certificate. Enabling this will clear any existing 'ca_pools' configuration to provision the certificates. ~> **Note** This field is mutually exclusive with 'ca_pools'. If this flag is enabled, certificates will be automatically provisioned from the default shared CAs. This flag should not be set if you want to use your own CA pools to provision the certificates.
- ca_poolsrecord of string | null
- inline_trust_configobject | null
Represents config to add additional trusted trust domains. Defines configuration for extending trust to additional trust domains. By establishing trust with another domain, the current domain will recognize and accept certificates issued by entities within the trusted domains. Note that a trust domain automatically trusts itself, eliminating the need for explicit configuration.
Fields
- additional_trust_bundlesobject[] | null
Maps specific trust domains (e.g., "example.com") to their corresponding 'TrustStore' objects, which contain the trusted root certificates for that domain. There can be a maximum of '10' trust domain entries in this map. Note that a trust domain automatically trusts itself and don't need to be specified here. If however, this 'WorkloadIdentityPool''s trust domain contains any trust anchors in the 'additional_trust_bundles' map, those trust anchors will be *appended to* the Trust Bundle automatically derived from your 'InlineCertificateIssuanceConfig''s 'ca_pools'.
Each item
- trust_default_shared_caboolean | null
If set to True, the trust bundle will include the private ca managed identity regional root public certificates. ~> **Note** 'trust_default_shared_ca' is only supported for managed identity trust domain resource.
- trust_domainstringrequired
- trust_anchorsobject[]required
List of Trust Anchors to be used while performing validation against a given 'TrustStore'. The incoming end entity's certificate must be chained up to one of the trust anchors here.
at least 1 item
Each item
- pem_certificatestringrequired
PEM certificate of the PKI used for validation. Must only contain one ca certificate(either root or intermediate cert).
- pem_certificatestringrequired
- trust_default_shared_caboolean | null
- additional_trust_bundlesobject[] | null
- timeoutsobject | null
Fields
- createstring | null
- deletestring | null
- updatestring | null
- deletion_policystring | null
- handlestring
The driver's data for the object, opaque: pass it back unchanged
update
Change a workload identity pool to match its declaration, replacing it where a field cannot change in place
Input
- idstringrequired
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
- desiredrecord of anyrequired
The declared fields; a write-only one may hold a secret marker
- expectobject
Fields
- action"none" | "create" | "update" | "replace" | "delete"required
- replacestring[]required
Output
- idstringrequired
at least 1 character
- stateobjectrequired
Fields
- deletion_policystring | null
Whether Terraform will be prevented from destroying the instance. Defaults to "DELETE". When a 'terraform destroy' or 'terraform apply' would delete the instance, 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.
- descriptionstring | null
A description of the pool. Cannot exceed 256 characters.
- disabledboolean | null
Whether the pool is disabled. You cannot use a disabled pool to exchange tokens, or use existing tokens to access resources. If the pool is re-enabled, existing tokens grant access again.
- display_namestring | null
A display name for the pool. Cannot exceed 32 characters.
- idstring | null
- modestring | null
The mode for the pool is operating in. Pools with an unspecified mode will operate as if they are in 'FEDERATION_ONLY' mode. ~> **Note** This field cannot be changed after the Workload Identity Pool is created. While 'terraform plan' may show an update if you change this field's value, 'terraform apply' **will fail with an API error** (such as 'Error 400: Attempted to update an immutable field.'). To specify a different 'mode', please create a new Workload Identity Pool resource. * 'FEDERATION_ONLY': Pools can only be used for federating external workload identities into Google Cloud. Unless otherwise noted, no structure or format constraints are applied to workload identities in a 'FEDERATION_ONLY' mode pool, and you may not create any resources within the pool besides providers. * 'TRUST_DOMAIN': Pools can be used to assign identities to Google Cloud workloads. All identities within a 'TRUST_DOMAIN' mode pool must consist of a single namespace and individual workload identifier. The subject identifier for all identities must conform to the following format: 'ns/<namespace>/sa/<workload_identifier>'. 'google_iam_workload_identity_pool_provider's cannot be created within 'TRUST_DOMAIN' mode pools. * 'SYSTEM_TRUST_DOMAIN': Pools are managed by Google Cloud services. Neither 'google_iam_workload_identity_pool_namespace's nor 'google_iam_workload_identity_pool_provider's can be created within 'SYSTEM_TRUST_DOMAIN' mode pools. All identities within a 'SYSTEM_TRUST_DOMAIN' mode pool are in one of the following formats: * 'spiffe://<trust-domain>/ns/<kubernetes-namespace>/sa/<kubernetes-service-account>' * 'spiffe://<trust-domain>/resources/<resource-scope>/<resource-name>' Possible values: ["FEDERATION_ONLY", "TRUST_DOMAIN", "SYSTEM_TRUST_DOMAIN"]
- namestring | null
The resource name of the pool as 'projects/{project_number}/locations/global/workloadIdentityPools/{workload_identity_pool_id}'.
- projectstring | null
- statestring | null
The state of the pool. * 'STATE_UNSPECIFIED': State unspecified. * 'ACTIVE': The pool is active, and may be used in Google Cloud policies. * 'DELETED': The pool is soft-deleted. Soft-deleted pools are permanently deleted after approximately 30 days. You can restore a soft-deleted pool using 'UndeleteWorkloadIdentityPool'. You cannot reuse the ID of a soft-deleted pool until it is permanently deleted. While a pool is deleted, you cannot use it to exchange tokens, or use existing tokens to access resources. If the pool is undeleted, existing tokens grant access again.
- workload_identity_pool_idstringrequired
The ID to use for the pool, which becomes the final component of the resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix 'gcp-' is reserved for use by Google, and may not be specified.
- attestation_rulesobject[] | null
Defines which workloads can receive an identity within a pool. When an AttestationRule is defined under a managed identity, matching workloads may receive that identity. A maximum of 50 AttestationRules can be set.
Each item
- google_cloud_resourcestringrequired
A single workload operating on Google Cloud. For example: '//run.googleapis.com/projects/123/type/Service/*'.
- google_cloud_resourcestringrequired
- inline_certificate_issuance_configobject | null
Represents configuration for generating mutual TLS (mTLS) certificates for the identities within this pool. Defines the Certificate Authority (CA) pool resources and configurations required for issuance and rotation of mTLS workload certificates.
Fields
- ca_poolsrecord of string | null
A required mapping of a cloud region to the CA pool resource located in that region used for certificate issuance, adhering to these constraints: * **Key format:** A supported cloud region name equivalent to the location identifier in the corresponding map entry's value. * **Value format:** A valid CA pool resource path format like: 'projects/{project}/locations/{location}/caPools/{ca_pool}' * **Region Matching:** Workloads are ONLY issued certificates from CA pools within the same region. Also the CA pool region (in value) must match the workload's region (key).
- key_algorithmstring | null
Key algorithm to use when generating the key pair. This key pair will be used to create the certificate. If unspecified, this will default to 'ECDSA_P256'. * 'RSA_2048': Specifies RSA with a 2048-bit modulus. * 'RSA_3072': Specifies RSA with a 3072-bit modulus. * 'RSA_4096': Specifies RSA with a 4096-bit modulus. * 'ECDSA_P256': Specifies ECDSA with curve P256. * 'ECDSA_P384': Specifies ECDSA with curve P384. Possible values: ["RSA_2048", "RSA_3072", "RSA_4096", "ECDSA_P256", "ECDSA_P384"]
- lifetimestring | null
Lifetime of the workload certificates issued by the CA pool in seconds. Must be between '86400s' (24 hours) to '2592000s' (30 days), ends in the suffix "'s'" (indicating seconds) and is preceded by the number of seconds. If unspecified, this will be defaulted to '86400s' (24 hours).
- rotation_window_percentagenumber | null
Rotation window percentage indicating when certificate rotation should be initiated based on remaining lifetime. Must be between '50' - '80'. If unspecified, this will be defaulted to '50'.
- use_default_shared_caboolean | null
If set to true, the trust domain will utilize the GCP-provisioned default CA. A default CA in the same region as the workload will be selected to issue the certificate. Enabling this will clear any existing 'ca_pools' configuration to provision the certificates. ~> **Note** This field is mutually exclusive with 'ca_pools'. If this flag is enabled, certificates will be automatically provisioned from the default shared CAs. This flag should not be set if you want to use your own CA pools to provision the certificates.
- ca_poolsrecord of string | null
- inline_trust_configobject | null
Represents config to add additional trusted trust domains. Defines configuration for extending trust to additional trust domains. By establishing trust with another domain, the current domain will recognize and accept certificates issued by entities within the trusted domains. Note that a trust domain automatically trusts itself, eliminating the need for explicit configuration.
Fields
- additional_trust_bundlesobject[] | null
Maps specific trust domains (e.g., "example.com") to their corresponding 'TrustStore' objects, which contain the trusted root certificates for that domain. There can be a maximum of '10' trust domain entries in this map. Note that a trust domain automatically trusts itself and don't need to be specified here. If however, this 'WorkloadIdentityPool''s trust domain contains any trust anchors in the 'additional_trust_bundles' map, those trust anchors will be *appended to* the Trust Bundle automatically derived from your 'InlineCertificateIssuanceConfig''s 'ca_pools'.
Each item
- trust_default_shared_caboolean | null
If set to True, the trust bundle will include the private ca managed identity regional root public certificates. ~> **Note** 'trust_default_shared_ca' is only supported for managed identity trust domain resource.
- trust_domainstringrequired
- trust_anchorsobject[]required
List of Trust Anchors to be used while performing validation against a given 'TrustStore'. The incoming end entity's certificate must be chained up to one of the trust anchors here.
at least 1 item
Each item
- pem_certificatestringrequired
PEM certificate of the PKI used for validation. Must only contain one ca certificate(either root or intermediate cert).
- pem_certificatestringrequired
- trust_default_shared_caboolean | null
- additional_trust_bundlesobject[] | null
- timeoutsobject | null
Fields
- createstring | null
- deletestring | null
- updatestring | null
- deletion_policystring | null
- handlestring
The driver's data for the object, opaque: pass it back unchanged
delete
Delete a workload identity pool; done already when it is gone
Input
- idstringrequired
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
Output
- idstringrequired
at least 1 character
- gonetruerequired
workloadIdentityProvider
import
Find a oidc trust by its projects/project/locations/global/workloadIdentityPools/pool/providers/provider or its binding id and read it; gone when there is none
Input
- idstringrequired
at least 1 character
Output
- idstringrequired
at least 1 character
- gonebooleanrequired
- stateobject
Fields
- attribute_conditionstring | null
[A Common Expression Language](https://github.com/google/cel-spec) expression, in plain text, to restrict what otherwise valid authentication credentials issued by the provider should not be accepted. The expression must output a boolean representing whether to allow the federation. The following keywords may be referenced in the expressions: * 'assertion': JSON representing the authentication credential issued by the provider. * 'google': The Google attributes mapped from the assertion in the 'attribute_mappings'. * 'attribute': The custom attributes mapped from the assertion in the 'attribute_mappings'. The maximum length of the attribute condition expression is 4096 characters. If unspecified, all valid authentication credential are accepted. The following example shows how to only allow credentials with a mapped 'google.groups' value of 'admins': ''' "'admins' in google.groups" '''
- attribute_mappingrecord of string | null
Maps attributes from authentication credentials issued by an external identity provider to Google Cloud attributes, such as 'subject' and 'segment'. Each key must be a string specifying the Google Cloud IAM attribute to map to. The following keys are supported: * 'google.subject': The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. Cannot exceed 127 characters. * 'google.groups': Groups the external identity belongs to. You can grant groups access to resources using an IAM 'principalSet' binding; access applies to all members of the group. You can also provide custom attributes by specifying 'attribute.{custom_attribute}', where '{custom_attribute}' is the name of the custom attribute to be mapped. You can define a maximum of 50 custom attributes. The maximum length of a mapped attribute key is 100 characters, and the key may only contain the characters [a-z0-9_]. You can reference these attributes in IAM policies to define fine-grained access for a workload to Google Cloud resources. For example: * 'google.subject': 'principal://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/subject/{value}' * 'google.groups': 'principalSet://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/group/{value}' * 'attribute.{custom_attribute}': 'principalSet://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/attribute.{custom_attribute}/{value}' Each value must be a [Common Expression Language](https://github.com/google/cel-spec) function that maps an identity provider credential to the normalized attribute specified by the corresponding map key. You can use the 'assertion' keyword in the expression to access a JSON representation of the authentication credential issued by the provider. The maximum length of an attribute mapping expression is 2048 characters. When evaluated, the total size of all mapped attributes must not exceed 8KB. For AWS providers, the following rules apply: - If no attribute mapping is defined, the following default mapping applies: ''' { "google.subject":"assertion.arn", "attribute.aws_role": "assertion.arn.contains('assumed-role')" " ? assertion.arn.extract('{account_arn}assumed-role/')" " + 'assumed-role/'" " + assertion.arn.extract('assumed-role/{role_name}/')" " : assertion.arn", } ''' - If any custom attribute mappings are defined, they must include a mapping to the 'google.subject' attribute. For OIDC providers, the following rules apply: - Custom attribute mappings must be defined, and must include a mapping to the 'google.subject' attribute. For example, the following maps the 'sub' claim of the incoming credential to the 'subject' attribute on a Google token. ''' {"google.subject": "assertion.sub"} '''
- deletion_policystring | null
Whether Terraform will be prevented from destroying the instance. Defaults to "DELETE". When a 'terraform destroy' or 'terraform apply' would delete the instance, 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.
- descriptionstring | null
A description for the provider. Cannot exceed 256 characters.
- disabledboolean | null
Whether the provider is disabled. You cannot use a disabled provider to exchange tokens. However, existing tokens still grant access.
- display_namestring | null
A display name for the provider. Cannot exceed 32 characters.
- idstring | null
- namestring | null
The resource name of the provider as 'projects/{project_number}/locations/global/workloadIdentityPools/{workload_identity_pool_id}/providers/{workload_identity_pool_provider_id}'.
- projectstring | null
- statestring | null
The state of the provider. * STATE_UNSPECIFIED: State unspecified. * ACTIVE: The provider is active, and may be used to validate authentication credentials. * DELETED: The provider is soft-deleted. Soft-deleted providers are permanently deleted after approximately 30 days. You can restore a soft-deleted provider using UndeleteWorkloadIdentityPoolProvider. You cannot reuse the ID of a soft-deleted provider until it is permanently deleted.
- workload_identity_pool_idstringrequired
The ID used for the pool, which is the final component of the pool resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix 'gcp-' is reserved for use by Google, and may not be specified.
- workload_identity_pool_provider_idstringrequired
The ID for the provider, which becomes the final component of the resource name. This value must be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix 'gcp-' is reserved for use by Google, and may not be specified.
- awsobject | null
An Amazon Web Services identity provider. Not compatible with the property oidc or saml.
Fields
- account_idstringrequired
The AWS account ID.
- account_idstringrequired
- oidcobject | null
An OpenId Connect 1.0 identity provider. Not compatible with the property aws or saml.
Fields
- allowed_audiencesstring[] | null
Acceptable values for the 'aud' field (audience) in the OIDC token. Token exchange requests are rejected if the token audience does not match one of the configured values. Each audience may be at most 256 characters. A maximum of 10 audiences may be configured. If this list is empty, the OIDC token audience must be equal to the full canonical resource name of the WorkloadIdentityPoolProvider, with or without the HTTPS prefix. For example: ''' //iam.googleapis.com/projects/<project-number>/locations/<location>/workloadIdentityPools/<pool-id>/providers/<provider-id> https://iam.googleapis.com/projects/<project-number>/locations/<location>/workloadIdentityPools/<pool-id>/providers/<provider-id> '''
- issuer_uristringrequired
The OIDC issuer URL.
- jwks_jsonstring | null
OIDC JWKs in JSON String format. For details on definition of a JWK, see https:tools.ietf.org/html/rfc7517. If not set, then we use the 'jwks_uri' from the discovery document fetched from the .well-known path for the 'issuer_uri'. Currently, RSA and EC asymmetric keys are supported. The JWK must use following format and include only the following fields: ''' { "keys": [ { "kty": "RSA/EC", "alg": "<algorithm>", "use": "sig", "kid": "<key-id>", "n": "", "e": "", "x": "", "y": "", "crv": "" } ] } '''
- allowed_audiencesstring[] | null
- samlobject | null
An SAML 2.0 identity provider. Not compatible with the property oidc or aws.
Fields
- idp_metadata_xmlstringrequired
SAML Identity provider configuration metadata xml doc.
- idp_metadata_xmlstringrequired
- timeoutsobject | null
Fields
- createstring | null
- deletestring | null
- updatestring | null
- x509object | null
An X.509-type identity provider represents a CA. It is trusted to assert a client identity if the client has a certificate that chains up to this CA.
Fields
- trust_storeobjectrequired
A Trust store, use this trust store as a wrapper to config the trust anchor and optional intermediate cas to help build the trust chain for the incoming end entity certificate. Follow the x509 guidelines to define those PEM encoded certs. Only 1 trust store is currently supported.
Fields
- intermediate_casobject[] | null
Set of intermediate CA certificates used for building the trust chain to trust anchor. IMPORTANT: Intermediate CAs are only supported when configuring x509 federation.
Each item
- pem_certificatestring | null
PEM certificate of the PKI used for validation. Must only contain one ca certificate(either root or intermediate cert).
- pem_certificatestring | null
- trust_anchorsobject[]required
List of Trust Anchors to be used while performing validation against a given TrustStore. The incoming end entity's certificate must be chained up to one of the trust anchors here.
at least 1 item
Each item
- pem_certificatestring | null
PEM certificate of the PKI used for validation. Must only contain one ca certificate(either root or intermediate cert).
- pem_certificatestring | null
- intermediate_casobject[] | null
- trust_storeobjectrequired
- attribute_conditionstring | null
- handlestring
The driver's data for the object, opaque: pass it back unchanged
read
Read a oidc trust as it is now; gone when it no longer exists
Input
- idstringrequired
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
Output
- idstringrequired
at least 1 character
- gonebooleanrequired
- stateobject
Fields
- attribute_conditionstring | null
[A Common Expression Language](https://github.com/google/cel-spec) expression, in plain text, to restrict what otherwise valid authentication credentials issued by the provider should not be accepted. The expression must output a boolean representing whether to allow the federation. The following keywords may be referenced in the expressions: * 'assertion': JSON representing the authentication credential issued by the provider. * 'google': The Google attributes mapped from the assertion in the 'attribute_mappings'. * 'attribute': The custom attributes mapped from the assertion in the 'attribute_mappings'. The maximum length of the attribute condition expression is 4096 characters. If unspecified, all valid authentication credential are accepted. The following example shows how to only allow credentials with a mapped 'google.groups' value of 'admins': ''' "'admins' in google.groups" '''
- attribute_mappingrecord of string | null
Maps attributes from authentication credentials issued by an external identity provider to Google Cloud attributes, such as 'subject' and 'segment'. Each key must be a string specifying the Google Cloud IAM attribute to map to. The following keys are supported: * 'google.subject': The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. Cannot exceed 127 characters. * 'google.groups': Groups the external identity belongs to. You can grant groups access to resources using an IAM 'principalSet' binding; access applies to all members of the group. You can also provide custom attributes by specifying 'attribute.{custom_attribute}', where '{custom_attribute}' is the name of the custom attribute to be mapped. You can define a maximum of 50 custom attributes. The maximum length of a mapped attribute key is 100 characters, and the key may only contain the characters [a-z0-9_]. You can reference these attributes in IAM policies to define fine-grained access for a workload to Google Cloud resources. For example: * 'google.subject': 'principal://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/subject/{value}' * 'google.groups': 'principalSet://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/group/{value}' * 'attribute.{custom_attribute}': 'principalSet://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/attribute.{custom_attribute}/{value}' Each value must be a [Common Expression Language](https://github.com/google/cel-spec) function that maps an identity provider credential to the normalized attribute specified by the corresponding map key. You can use the 'assertion' keyword in the expression to access a JSON representation of the authentication credential issued by the provider. The maximum length of an attribute mapping expression is 2048 characters. When evaluated, the total size of all mapped attributes must not exceed 8KB. For AWS providers, the following rules apply: - If no attribute mapping is defined, the following default mapping applies: ''' { "google.subject":"assertion.arn", "attribute.aws_role": "assertion.arn.contains('assumed-role')" " ? assertion.arn.extract('{account_arn}assumed-role/')" " + 'assumed-role/'" " + assertion.arn.extract('assumed-role/{role_name}/')" " : assertion.arn", } ''' - If any custom attribute mappings are defined, they must include a mapping to the 'google.subject' attribute. For OIDC providers, the following rules apply: - Custom attribute mappings must be defined, and must include a mapping to the 'google.subject' attribute. For example, the following maps the 'sub' claim of the incoming credential to the 'subject' attribute on a Google token. ''' {"google.subject": "assertion.sub"} '''
- deletion_policystring | null
Whether Terraform will be prevented from destroying the instance. Defaults to "DELETE". When a 'terraform destroy' or 'terraform apply' would delete the instance, 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.
- descriptionstring | null
A description for the provider. Cannot exceed 256 characters.
- disabledboolean | null
Whether the provider is disabled. You cannot use a disabled provider to exchange tokens. However, existing tokens still grant access.
- display_namestring | null
A display name for the provider. Cannot exceed 32 characters.
- idstring | null
- namestring | null
The resource name of the provider as 'projects/{project_number}/locations/global/workloadIdentityPools/{workload_identity_pool_id}/providers/{workload_identity_pool_provider_id}'.
- projectstring | null
- statestring | null
The state of the provider. * STATE_UNSPECIFIED: State unspecified. * ACTIVE: The provider is active, and may be used to validate authentication credentials. * DELETED: The provider is soft-deleted. Soft-deleted providers are permanently deleted after approximately 30 days. You can restore a soft-deleted provider using UndeleteWorkloadIdentityPoolProvider. You cannot reuse the ID of a soft-deleted provider until it is permanently deleted.
- workload_identity_pool_idstringrequired
The ID used for the pool, which is the final component of the pool resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix 'gcp-' is reserved for use by Google, and may not be specified.
- workload_identity_pool_provider_idstringrequired
The ID for the provider, which becomes the final component of the resource name. This value must be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix 'gcp-' is reserved for use by Google, and may not be specified.
- awsobject | null
An Amazon Web Services identity provider. Not compatible with the property oidc or saml.
Fields
- account_idstringrequired
The AWS account ID.
- account_idstringrequired
- oidcobject | null
An OpenId Connect 1.0 identity provider. Not compatible with the property aws or saml.
Fields
- allowed_audiencesstring[] | null
Acceptable values for the 'aud' field (audience) in the OIDC token. Token exchange requests are rejected if the token audience does not match one of the configured values. Each audience may be at most 256 characters. A maximum of 10 audiences may be configured. If this list is empty, the OIDC token audience must be equal to the full canonical resource name of the WorkloadIdentityPoolProvider, with or without the HTTPS prefix. For example: ''' //iam.googleapis.com/projects/<project-number>/locations/<location>/workloadIdentityPools/<pool-id>/providers/<provider-id> https://iam.googleapis.com/projects/<project-number>/locations/<location>/workloadIdentityPools/<pool-id>/providers/<provider-id> '''
- issuer_uristringrequired
The OIDC issuer URL.
- jwks_jsonstring | null
OIDC JWKs in JSON String format. For details on definition of a JWK, see https:tools.ietf.org/html/rfc7517. If not set, then we use the 'jwks_uri' from the discovery document fetched from the .well-known path for the 'issuer_uri'. Currently, RSA and EC asymmetric keys are supported. The JWK must use following format and include only the following fields: ''' { "keys": [ { "kty": "RSA/EC", "alg": "<algorithm>", "use": "sig", "kid": "<key-id>", "n": "", "e": "", "x": "", "y": "", "crv": "" } ] } '''
- allowed_audiencesstring[] | null
- samlobject | null
An SAML 2.0 identity provider. Not compatible with the property oidc or aws.
Fields
- idp_metadata_xmlstringrequired
SAML Identity provider configuration metadata xml doc.
- idp_metadata_xmlstringrequired
- timeoutsobject | null
Fields
- createstring | null
- deletestring | null
- updatestring | null
- x509object | null
An X.509-type identity provider represents a CA. It is trusted to assert a client identity if the client has a certificate that chains up to this CA.
Fields
- trust_storeobjectrequired
A Trust store, use this trust store as a wrapper to config the trust anchor and optional intermediate cas to help build the trust chain for the incoming end entity certificate. Follow the x509 guidelines to define those PEM encoded certs. Only 1 trust store is currently supported.
Fields
- intermediate_casobject[] | null
Set of intermediate CA certificates used for building the trust chain to trust anchor. IMPORTANT: Intermediate CAs are only supported when configuring x509 federation.
Each item
- pem_certificatestring | null
PEM certificate of the PKI used for validation. Must only contain one ca certificate(either root or intermediate cert).
- pem_certificatestring | null
- trust_anchorsobject[]required
List of Trust Anchors to be used while performing validation against a given TrustStore. The incoming end entity's certificate must be chained up to one of the trust anchors here.
at least 1 item
Each item
- pem_certificatestring | null
PEM certificate of the PKI used for validation. Must only contain one ca certificate(either root or intermediate cert).
- pem_certificatestring | null
- intermediate_casobject[] | null
- trust_storeobjectrequired
- attribute_conditionstring | null
- handlestring
The driver's data for the object, opaque: pass it back unchanged
plan
Plan how apply would make a oidc trust match its declaration (or delete it, given none); nothing changes
Input
- idstring
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
- desiredrecord of any
The declared fields; a write-only one may hold a secret marker
Output
- action"none" | "create" | "update" | "replace" | "delete"required
- plannedrecord of any
- unknownstring[]required
- replacestring[]required
The fields whose change replaces the object: not empty exactly when
replace
create
Create a oidc trust as declared
Input
- desiredrecord of anyrequired
The declared fields; a write-only one may hold a secret marker
Output
- idstringrequired
at least 1 character
- stateobjectrequired
Fields
- attribute_conditionstring | null
[A Common Expression Language](https://github.com/google/cel-spec) expression, in plain text, to restrict what otherwise valid authentication credentials issued by the provider should not be accepted. The expression must output a boolean representing whether to allow the federation. The following keywords may be referenced in the expressions: * 'assertion': JSON representing the authentication credential issued by the provider. * 'google': The Google attributes mapped from the assertion in the 'attribute_mappings'. * 'attribute': The custom attributes mapped from the assertion in the 'attribute_mappings'. The maximum length of the attribute condition expression is 4096 characters. If unspecified, all valid authentication credential are accepted. The following example shows how to only allow credentials with a mapped 'google.groups' value of 'admins': ''' "'admins' in google.groups" '''
- attribute_mappingrecord of string | null
Maps attributes from authentication credentials issued by an external identity provider to Google Cloud attributes, such as 'subject' and 'segment'. Each key must be a string specifying the Google Cloud IAM attribute to map to. The following keys are supported: * 'google.subject': The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. Cannot exceed 127 characters. * 'google.groups': Groups the external identity belongs to. You can grant groups access to resources using an IAM 'principalSet' binding; access applies to all members of the group. You can also provide custom attributes by specifying 'attribute.{custom_attribute}', where '{custom_attribute}' is the name of the custom attribute to be mapped. You can define a maximum of 50 custom attributes. The maximum length of a mapped attribute key is 100 characters, and the key may only contain the characters [a-z0-9_]. You can reference these attributes in IAM policies to define fine-grained access for a workload to Google Cloud resources. For example: * 'google.subject': 'principal://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/subject/{value}' * 'google.groups': 'principalSet://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/group/{value}' * 'attribute.{custom_attribute}': 'principalSet://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/attribute.{custom_attribute}/{value}' Each value must be a [Common Expression Language](https://github.com/google/cel-spec) function that maps an identity provider credential to the normalized attribute specified by the corresponding map key. You can use the 'assertion' keyword in the expression to access a JSON representation of the authentication credential issued by the provider. The maximum length of an attribute mapping expression is 2048 characters. When evaluated, the total size of all mapped attributes must not exceed 8KB. For AWS providers, the following rules apply: - If no attribute mapping is defined, the following default mapping applies: ''' { "google.subject":"assertion.arn", "attribute.aws_role": "assertion.arn.contains('assumed-role')" " ? assertion.arn.extract('{account_arn}assumed-role/')" " + 'assumed-role/'" " + assertion.arn.extract('assumed-role/{role_name}/')" " : assertion.arn", } ''' - If any custom attribute mappings are defined, they must include a mapping to the 'google.subject' attribute. For OIDC providers, the following rules apply: - Custom attribute mappings must be defined, and must include a mapping to the 'google.subject' attribute. For example, the following maps the 'sub' claim of the incoming credential to the 'subject' attribute on a Google token. ''' {"google.subject": "assertion.sub"} '''
- deletion_policystring | null
Whether Terraform will be prevented from destroying the instance. Defaults to "DELETE". When a 'terraform destroy' or 'terraform apply' would delete the instance, 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.
- descriptionstring | null
A description for the provider. Cannot exceed 256 characters.
- disabledboolean | null
Whether the provider is disabled. You cannot use a disabled provider to exchange tokens. However, existing tokens still grant access.
- display_namestring | null
A display name for the provider. Cannot exceed 32 characters.
- idstring | null
- namestring | null
The resource name of the provider as 'projects/{project_number}/locations/global/workloadIdentityPools/{workload_identity_pool_id}/providers/{workload_identity_pool_provider_id}'.
- projectstring | null
- statestring | null
The state of the provider. * STATE_UNSPECIFIED: State unspecified. * ACTIVE: The provider is active, and may be used to validate authentication credentials. * DELETED: The provider is soft-deleted. Soft-deleted providers are permanently deleted after approximately 30 days. You can restore a soft-deleted provider using UndeleteWorkloadIdentityPoolProvider. You cannot reuse the ID of a soft-deleted provider until it is permanently deleted.
- workload_identity_pool_idstringrequired
The ID used for the pool, which is the final component of the pool resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix 'gcp-' is reserved for use by Google, and may not be specified.
- workload_identity_pool_provider_idstringrequired
The ID for the provider, which becomes the final component of the resource name. This value must be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix 'gcp-' is reserved for use by Google, and may not be specified.
- awsobject | null
An Amazon Web Services identity provider. Not compatible with the property oidc or saml.
Fields
- account_idstringrequired
The AWS account ID.
- account_idstringrequired
- oidcobject | null
An OpenId Connect 1.0 identity provider. Not compatible with the property aws or saml.
Fields
- allowed_audiencesstring[] | null
Acceptable values for the 'aud' field (audience) in the OIDC token. Token exchange requests are rejected if the token audience does not match one of the configured values. Each audience may be at most 256 characters. A maximum of 10 audiences may be configured. If this list is empty, the OIDC token audience must be equal to the full canonical resource name of the WorkloadIdentityPoolProvider, with or without the HTTPS prefix. For example: ''' //iam.googleapis.com/projects/<project-number>/locations/<location>/workloadIdentityPools/<pool-id>/providers/<provider-id> https://iam.googleapis.com/projects/<project-number>/locations/<location>/workloadIdentityPools/<pool-id>/providers/<provider-id> '''
- issuer_uristringrequired
The OIDC issuer URL.
- jwks_jsonstring | null
OIDC JWKs in JSON String format. For details on definition of a JWK, see https:tools.ietf.org/html/rfc7517. If not set, then we use the 'jwks_uri' from the discovery document fetched from the .well-known path for the 'issuer_uri'. Currently, RSA and EC asymmetric keys are supported. The JWK must use following format and include only the following fields: ''' { "keys": [ { "kty": "RSA/EC", "alg": "<algorithm>", "use": "sig", "kid": "<key-id>", "n": "", "e": "", "x": "", "y": "", "crv": "" } ] } '''
- allowed_audiencesstring[] | null
- samlobject | null
An SAML 2.0 identity provider. Not compatible with the property oidc or aws.
Fields
- idp_metadata_xmlstringrequired
SAML Identity provider configuration metadata xml doc.
- idp_metadata_xmlstringrequired
- timeoutsobject | null
Fields
- createstring | null
- deletestring | null
- updatestring | null
- x509object | null
An X.509-type identity provider represents a CA. It is trusted to assert a client identity if the client has a certificate that chains up to this CA.
Fields
- trust_storeobjectrequired
A Trust store, use this trust store as a wrapper to config the trust anchor and optional intermediate cas to help build the trust chain for the incoming end entity certificate. Follow the x509 guidelines to define those PEM encoded certs. Only 1 trust store is currently supported.
Fields
- intermediate_casobject[] | null
Set of intermediate CA certificates used for building the trust chain to trust anchor. IMPORTANT: Intermediate CAs are only supported when configuring x509 federation.
Each item
- pem_certificatestring | null
PEM certificate of the PKI used for validation. Must only contain one ca certificate(either root or intermediate cert).
- pem_certificatestring | null
- trust_anchorsobject[]required
List of Trust Anchors to be used while performing validation against a given TrustStore. The incoming end entity's certificate must be chained up to one of the trust anchors here.
at least 1 item
Each item
- pem_certificatestring | null
PEM certificate of the PKI used for validation. Must only contain one ca certificate(either root or intermediate cert).
- pem_certificatestring | null
- intermediate_casobject[] | null
- trust_storeobjectrequired
- attribute_conditionstring | null
- handlestring
The driver's data for the object, opaque: pass it back unchanged
update
Change a oidc trust to match its declaration, replacing it where a field cannot change in place
Input
- idstringrequired
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
- desiredrecord of anyrequired
The declared fields; a write-only one may hold a secret marker
- expectobject
Fields
- action"none" | "create" | "update" | "replace" | "delete"required
- replacestring[]required
Output
- idstringrequired
at least 1 character
- stateobjectrequired
Fields
- attribute_conditionstring | null
[A Common Expression Language](https://github.com/google/cel-spec) expression, in plain text, to restrict what otherwise valid authentication credentials issued by the provider should not be accepted. The expression must output a boolean representing whether to allow the federation. The following keywords may be referenced in the expressions: * 'assertion': JSON representing the authentication credential issued by the provider. * 'google': The Google attributes mapped from the assertion in the 'attribute_mappings'. * 'attribute': The custom attributes mapped from the assertion in the 'attribute_mappings'. The maximum length of the attribute condition expression is 4096 characters. If unspecified, all valid authentication credential are accepted. The following example shows how to only allow credentials with a mapped 'google.groups' value of 'admins': ''' "'admins' in google.groups" '''
- attribute_mappingrecord of string | null
Maps attributes from authentication credentials issued by an external identity provider to Google Cloud attributes, such as 'subject' and 'segment'. Each key must be a string specifying the Google Cloud IAM attribute to map to. The following keys are supported: * 'google.subject': The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. Cannot exceed 127 characters. * 'google.groups': Groups the external identity belongs to. You can grant groups access to resources using an IAM 'principalSet' binding; access applies to all members of the group. You can also provide custom attributes by specifying 'attribute.{custom_attribute}', where '{custom_attribute}' is the name of the custom attribute to be mapped. You can define a maximum of 50 custom attributes. The maximum length of a mapped attribute key is 100 characters, and the key may only contain the characters [a-z0-9_]. You can reference these attributes in IAM policies to define fine-grained access for a workload to Google Cloud resources. For example: * 'google.subject': 'principal://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/subject/{value}' * 'google.groups': 'principalSet://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/group/{value}' * 'attribute.{custom_attribute}': 'principalSet://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/attribute.{custom_attribute}/{value}' Each value must be a [Common Expression Language](https://github.com/google/cel-spec) function that maps an identity provider credential to the normalized attribute specified by the corresponding map key. You can use the 'assertion' keyword in the expression to access a JSON representation of the authentication credential issued by the provider. The maximum length of an attribute mapping expression is 2048 characters. When evaluated, the total size of all mapped attributes must not exceed 8KB. For AWS providers, the following rules apply: - If no attribute mapping is defined, the following default mapping applies: ''' { "google.subject":"assertion.arn", "attribute.aws_role": "assertion.arn.contains('assumed-role')" " ? assertion.arn.extract('{account_arn}assumed-role/')" " + 'assumed-role/'" " + assertion.arn.extract('assumed-role/{role_name}/')" " : assertion.arn", } ''' - If any custom attribute mappings are defined, they must include a mapping to the 'google.subject' attribute. For OIDC providers, the following rules apply: - Custom attribute mappings must be defined, and must include a mapping to the 'google.subject' attribute. For example, the following maps the 'sub' claim of the incoming credential to the 'subject' attribute on a Google token. ''' {"google.subject": "assertion.sub"} '''
- deletion_policystring | null
Whether Terraform will be prevented from destroying the instance. Defaults to "DELETE". When a 'terraform destroy' or 'terraform apply' would delete the instance, 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.
- descriptionstring | null
A description for the provider. Cannot exceed 256 characters.
- disabledboolean | null
Whether the provider is disabled. You cannot use a disabled provider to exchange tokens. However, existing tokens still grant access.
- display_namestring | null
A display name for the provider. Cannot exceed 32 characters.
- idstring | null
- namestring | null
The resource name of the provider as 'projects/{project_number}/locations/global/workloadIdentityPools/{workload_identity_pool_id}/providers/{workload_identity_pool_provider_id}'.
- projectstring | null
- statestring | null
The state of the provider. * STATE_UNSPECIFIED: State unspecified. * ACTIVE: The provider is active, and may be used to validate authentication credentials. * DELETED: The provider is soft-deleted. Soft-deleted providers are permanently deleted after approximately 30 days. You can restore a soft-deleted provider using UndeleteWorkloadIdentityPoolProvider. You cannot reuse the ID of a soft-deleted provider until it is permanently deleted.
- workload_identity_pool_idstringrequired
The ID used for the pool, which is the final component of the pool resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix 'gcp-' is reserved for use by Google, and may not be specified.
- workload_identity_pool_provider_idstringrequired
The ID for the provider, which becomes the final component of the resource name. This value must be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix 'gcp-' is reserved for use by Google, and may not be specified.
- awsobject | null
An Amazon Web Services identity provider. Not compatible with the property oidc or saml.
Fields
- account_idstringrequired
The AWS account ID.
- account_idstringrequired
- oidcobject | null
An OpenId Connect 1.0 identity provider. Not compatible with the property aws or saml.
Fields
- allowed_audiencesstring[] | null
Acceptable values for the 'aud' field (audience) in the OIDC token. Token exchange requests are rejected if the token audience does not match one of the configured values. Each audience may be at most 256 characters. A maximum of 10 audiences may be configured. If this list is empty, the OIDC token audience must be equal to the full canonical resource name of the WorkloadIdentityPoolProvider, with or without the HTTPS prefix. For example: ''' //iam.googleapis.com/projects/<project-number>/locations/<location>/workloadIdentityPools/<pool-id>/providers/<provider-id> https://iam.googleapis.com/projects/<project-number>/locations/<location>/workloadIdentityPools/<pool-id>/providers/<provider-id> '''
- issuer_uristringrequired
The OIDC issuer URL.
- jwks_jsonstring | null
OIDC JWKs in JSON String format. For details on definition of a JWK, see https:tools.ietf.org/html/rfc7517. If not set, then we use the 'jwks_uri' from the discovery document fetched from the .well-known path for the 'issuer_uri'. Currently, RSA and EC asymmetric keys are supported. The JWK must use following format and include only the following fields: ''' { "keys": [ { "kty": "RSA/EC", "alg": "<algorithm>", "use": "sig", "kid": "<key-id>", "n": "", "e": "", "x": "", "y": "", "crv": "" } ] } '''
- allowed_audiencesstring[] | null
- samlobject | null
An SAML 2.0 identity provider. Not compatible with the property oidc or aws.
Fields
- idp_metadata_xmlstringrequired
SAML Identity provider configuration metadata xml doc.
- idp_metadata_xmlstringrequired
- timeoutsobject | null
Fields
- createstring | null
- deletestring | null
- updatestring | null
- x509object | null
An X.509-type identity provider represents a CA. It is trusted to assert a client identity if the client has a certificate that chains up to this CA.
Fields
- trust_storeobjectrequired
A Trust store, use this trust store as a wrapper to config the trust anchor and optional intermediate cas to help build the trust chain for the incoming end entity certificate. Follow the x509 guidelines to define those PEM encoded certs. Only 1 trust store is currently supported.
Fields
- intermediate_casobject[] | null
Set of intermediate CA certificates used for building the trust chain to trust anchor. IMPORTANT: Intermediate CAs are only supported when configuring x509 federation.
Each item
- pem_certificatestring | null
PEM certificate of the PKI used for validation. Must only contain one ca certificate(either root or intermediate cert).
- pem_certificatestring | null
- trust_anchorsobject[]required
List of Trust Anchors to be used while performing validation against a given TrustStore. The incoming end entity's certificate must be chained up to one of the trust anchors here.
at least 1 item
Each item
- pem_certificatestring | null
PEM certificate of the PKI used for validation. Must only contain one ca certificate(either root or intermediate cert).
- pem_certificatestring | null
- intermediate_casobject[] | null
- trust_storeobjectrequired
- attribute_conditionstring | null
- handlestring
The driver's data for the object, opaque: pass it back unchanged
delete
Delete a oidc trust; done already when it is gone
Input
- idstringrequired
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
Output
- idstringrequired
at least 1 character
- gonetruerequired
customRole
import
Find a custom role by its projects/project/roles/role_id or its binding id and read it; gone when there is none
Input
- idstringrequired
at least 1 character
Output
- idstringrequired
at least 1 character
- gonebooleanrequired
- stateobject
Fields
- deletedboolean | null
The current deleted state of the role.
- deletion_policystring | null
Whether Terraform will be prevented from destroying the instance. Defaults to "DELETE". When a 'terraform destroy' or 'terraform apply' would delete the instance, 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.
- descriptionstring | null
A human-readable description for the role.
- idstring | null
- namestring | null
The name of the role in the format projects/{{project}}/roles/{{role_id}}. Like id, this field can be used as a reference in other resources such as IAM role bindings.
- permissionsstring[]required
The names of the permissions this role grants when bound in an IAM policy. At least one permission must be specified.
- projectstring | null
The project that the service account will be created in. Defaults to the provider project configuration.
- role_idstringrequired
The camel case role id to use for this role. Cannot contain - characters.
- stagestring | null
The current launch stage of the role. Defaults to GA.
- titlestringrequired
A human-readable title for the role.
- deletedboolean | null
- handlestring
The driver's data for the object, opaque: pass it back unchanged
read
Read a custom role as it is now; gone when it no longer exists
Input
- idstringrequired
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
Output
- idstringrequired
at least 1 character
- gonebooleanrequired
- stateobject
Fields
- deletedboolean | null
The current deleted state of the role.
- deletion_policystring | null
Whether Terraform will be prevented from destroying the instance. Defaults to "DELETE". When a 'terraform destroy' or 'terraform apply' would delete the instance, 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.
- descriptionstring | null
A human-readable description for the role.
- idstring | null
- namestring | null
The name of the role in the format projects/{{project}}/roles/{{role_id}}. Like id, this field can be used as a reference in other resources such as IAM role bindings.
- permissionsstring[]required
The names of the permissions this role grants when bound in an IAM policy. At least one permission must be specified.
- projectstring | null
The project that the service account will be created in. Defaults to the provider project configuration.
- role_idstringrequired
The camel case role id to use for this role. Cannot contain - characters.
- stagestring | null
The current launch stage of the role. Defaults to GA.
- titlestringrequired
A human-readable title for the role.
- deletedboolean | null
- handlestring
The driver's data for the object, opaque: pass it back unchanged
plan
Plan how apply would make a custom role match its declaration (or delete it, given none); nothing changes
Input
- idstring
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
- desiredrecord of any
The declared fields; a write-only one may hold a secret marker
Output
- action"none" | "create" | "update" | "replace" | "delete"required
- plannedrecord of any
- unknownstring[]required
- replacestring[]required
The fields whose change replaces the object: not empty exactly when
replace
create
Create a custom role as declared
Input
- desiredrecord of anyrequired
The declared fields; a write-only one may hold a secret marker
Output
- idstringrequired
at least 1 character
- stateobjectrequired
Fields
- deletedboolean | null
The current deleted state of the role.
- deletion_policystring | null
Whether Terraform will be prevented from destroying the instance. Defaults to "DELETE". When a 'terraform destroy' or 'terraform apply' would delete the instance, 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.
- descriptionstring | null
A human-readable description for the role.
- idstring | null
- namestring | null
The name of the role in the format projects/{{project}}/roles/{{role_id}}. Like id, this field can be used as a reference in other resources such as IAM role bindings.
- permissionsstring[]required
The names of the permissions this role grants when bound in an IAM policy. At least one permission must be specified.
- projectstring | null
The project that the service account will be created in. Defaults to the provider project configuration.
- role_idstringrequired
The camel case role id to use for this role. Cannot contain - characters.
- stagestring | null
The current launch stage of the role. Defaults to GA.
- titlestringrequired
A human-readable title for the role.
- deletedboolean | null
- handlestring
The driver's data for the object, opaque: pass it back unchanged
update
Change a custom role to match its declaration, replacing it where a field cannot change in place
Input
- idstringrequired
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
- desiredrecord of anyrequired
The declared fields; a write-only one may hold a secret marker
- expectobject
Fields
- action"none" | "create" | "update" | "replace" | "delete"required
- replacestring[]required
Output
- idstringrequired
at least 1 character
- stateobjectrequired
Fields
- deletedboolean | null
The current deleted state of the role.
- deletion_policystring | null
Whether Terraform will be prevented from destroying the instance. Defaults to "DELETE". When a 'terraform destroy' or 'terraform apply' would delete the instance, 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.
- descriptionstring | null
A human-readable description for the role.
- idstring | null
- namestring | null
The name of the role in the format projects/{{project}}/roles/{{role_id}}. Like id, this field can be used as a reference in other resources such as IAM role bindings.
- permissionsstring[]required
The names of the permissions this role grants when bound in an IAM policy. At least one permission must be specified.
- projectstring | null
The project that the service account will be created in. Defaults to the provider project configuration.
- role_idstringrequired
The camel case role id to use for this role. Cannot contain - characters.
- stagestring | null
The current launch stage of the role. Defaults to GA.
- titlestringrequired
A human-readable title for the role.
- deletedboolean | null
- handlestring
The driver's data for the object, opaque: pass it back unchanged
delete
Delete a custom role; done already when it is gone
Input
- idstringrequired
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
Output
- idstringrequired
at least 1 character
- gonetruerequired
auditConfig
import
Find a audit logging by its project service or its binding id and read it; gone when there is none
Input
- idstringrequired
at least 1 character
Output
- idstringrequired
at least 1 character
- gonebooleanrequired
- stateobject
Fields
- etagstring | null
The etag of iam policy
- idstring | null
- projectstringrequired
- servicestringrequired
Service which will be enabled for audit logging. The special value allServices covers all services.
- audit_log_configobject[]required
The configuration for logging of each type of permission. This can be specified multiple times.
at least 1 item
Each item
- exempted_membersstring[] | null
Identities that do not cause logging for this type of permission. Each entry can have one of the following values:user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com. serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
- log_typestringrequired
Permission type for which logging is to be configured. Must be one of DATA_READ, DATA_WRITE, or ADMIN_READ.
- exempted_membersstring[] | null
- etagstring | null
- handlestring
The driver's data for the object, opaque: pass it back unchanged
read
Read a audit logging as it is now; gone when it no longer exists
Input
- idstringrequired
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
Output
- idstringrequired
at least 1 character
- gonebooleanrequired
- stateobject
Fields
- etagstring | null
The etag of iam policy
- idstring | null
- projectstringrequired
- servicestringrequired
Service which will be enabled for audit logging. The special value allServices covers all services.
- audit_log_configobject[]required
The configuration for logging of each type of permission. This can be specified multiple times.
at least 1 item
Each item
- exempted_membersstring[] | null
Identities that do not cause logging for this type of permission. Each entry can have one of the following values:user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com. serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
- log_typestringrequired
Permission type for which logging is to be configured. Must be one of DATA_READ, DATA_WRITE, or ADMIN_READ.
- exempted_membersstring[] | null
- etagstring | null
- handlestring
The driver's data for the object, opaque: pass it back unchanged
plan
Plan how apply would make a audit logging match its declaration (or delete it, given none); nothing changes
Input
- idstring
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
- desiredrecord of any
The declared fields; a write-only one may hold a secret marker
Output
- action"none" | "create" | "update" | "replace" | "delete"required
- plannedrecord of any
- unknownstring[]required
- replacestring[]required
The fields whose change replaces the object: not empty exactly when
replace
create
Create a audit logging as declared
Input
- desiredrecord of anyrequired
The declared fields; a write-only one may hold a secret marker
Output
- idstringrequired
at least 1 character
- stateobjectrequired
Fields
- etagstring | null
The etag of iam policy
- idstring | null
- projectstringrequired
- servicestringrequired
Service which will be enabled for audit logging. The special value allServices covers all services.
- audit_log_configobject[]required
The configuration for logging of each type of permission. This can be specified multiple times.
at least 1 item
Each item
- exempted_membersstring[] | null
Identities that do not cause logging for this type of permission. Each entry can have one of the following values:user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com. serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
- log_typestringrequired
Permission type for which logging is to be configured. Must be one of DATA_READ, DATA_WRITE, or ADMIN_READ.
- exempted_membersstring[] | null
- etagstring | null
- handlestring
The driver's data for the object, opaque: pass it back unchanged
update
Change a audit logging to match its declaration, replacing it where a field cannot change in place
Input
- idstringrequired
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
- desiredrecord of anyrequired
The declared fields; a write-only one may hold a secret marker
- expectobject
Fields
- action"none" | "create" | "update" | "replace" | "delete"required
- replacestring[]required
Output
- idstringrequired
at least 1 character
- stateobjectrequired
Fields
- etagstring | null
The etag of iam policy
- idstring | null
- projectstringrequired
- servicestringrequired
Service which will be enabled for audit logging. The special value allServices covers all services.
- audit_log_configobject[]required
The configuration for logging of each type of permission. This can be specified multiple times.
at least 1 item
Each item
- exempted_membersstring[] | null
Identities that do not cause logging for this type of permission. Each entry can have one of the following values:user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com. serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
- log_typestringrequired
Permission type for which logging is to be configured. Must be one of DATA_READ, DATA_WRITE, or ADMIN_READ.
- exempted_membersstring[] | null
- etagstring | null
- handlestring
The driver's data for the object, opaque: pass it back unchanged
delete
Delete a audit logging; done already when it is gone
Input
- idstringrequired
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
Output
- idstringrequired
at least 1 character
- gonetruerequired
cloudRunService
import
Find a cloud run service by its projects/project/locations/location/services/name or its binding id and read it; gone when there is none
Input
- idstringrequired
at least 1 character
Output
- idstringrequired
at least 1 character
- gonebooleanrequired
- stateobject
Fields
- annotationsrecord of string | null
Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with 'run.googleapis.com', 'cloud.googleapis.com', 'serving.knative.dev', or 'autoscaling.knative.dev' namespaces, and they will be rejected in new resources. All system annotations in v1 now have a corresponding field in v2 Service. This field follows Kubernetes annotations' namespacing, limits, and rules. **Note**: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field 'effective_annotations' for all of the annotations present on the resource.
- clientstring | null
Arbitrary identifier for the API client.
- client_versionstring | null
Arbitrary version identifier for the API client.
- conditionsobject[] | null
The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the Service does not reach its Serving state. See comments in reconciling for additional information on reconciliation process in Cloud Run.
Each item
- execution_reasonstring | null
- last_transition_timestring | null
- messagestring | null
- reasonstring | null
- revision_reasonstring | null
- severitystring | null
- statestring | null
- typestring | null
- create_timestring | null
The creation time.
- creatorstring | null
Email address of the authenticated creator.
- custom_audiencesstring[] | null
One or more custom audiences that you want this service to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences.
- default_uri_disabledboolean | null
Disables public resolution of the default URI of this service.
- delete_timestring | null
The deletion time.
- deletion_policystring | null
Whether Terraform will be prevented from destroying the instance. Defaults to "DELETE". When a 'terraform destroy' or 'terraform apply' would delete the instance, 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.
- deletion_protectionboolean | null
Whether Terraform will be prevented from destroying the service. Defaults to true. When a'terraform destroy' or 'terraform apply' would delete the service, the command will fail if this field is not set to false in Terraform state. When the field is set to true or unset in Terraform state, a 'terraform apply' or 'terraform destroy' that would delete the service will fail. When the field is set to false, deleting the service is allowed.
- descriptionstring | null
User-provided description of the Service. This field currently has a 512-character limit.
- effective_annotationsrecord of string | null
All of annotations (key/value pairs) present on the resource in GCP, including the annotations configured through Terraform, other clients and services.
- effective_labelsrecord of string | null
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Terraform, other clients and services.
- etagstring | null
A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
- expire_timestring | null
For a deleted resource, the time after which it will be permanently deleted.
- generationstring | null
A number that monotonically increases every time the user modifies the desired state. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a string instead of an integer.
- iap_enabledboolean | null
Used to enable/disable IAP for the cloud-run service.
- idstring | null
- ingressstring | null
Provides the ingress settings for this Service. On output, returns the currently observed ingress settings, or INGRESS_TRAFFIC_UNSPECIFIED if no revision is active. Possible values: ["INGRESS_TRAFFIC_ALL", "INGRESS_TRAFFIC_INTERNAL_ONLY", "INGRESS_TRAFFIC_INTERNAL_LOAD_BALANCER"]
- invoker_iam_disabledboolean | null
Disables IAM permission check for run.routes.invoke for callers of this service. For more information, visit https://cloud.google.com/run/docs/securing/managing-access#invoker_check.
- labelsrecord of string | null
Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://docs.cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with 'run.googleapis.com', 'cloud.googleapis.com', 'serving.knative.dev', or 'autoscaling.knative.dev' namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 Service. **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.
- last_modifierstring | null
Email address of the last authenticated modifier.
- latest_created_revisionstring | null
Name of the last created revision. See comments in reconciling for additional information on reconciliation process in Cloud Run.
- latest_ready_revisionstring | null
Name of the latest revision that is serving traffic. See comments in reconciling for additional information on reconciliation process in Cloud Run.
- launch_stagestring | null
The launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/products#product-launch-stages). Cloud Run supports ALPHA, BETA, and GA. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output. Possible values: ["UNIMPLEMENTED", "PRELAUNCH", "EARLY_ACCESS", "ALPHA", "BETA", "GA", "DEPRECATED"]
- locationstringrequired
The location of the cloud run service
- namestringrequired
Name of the Service.
- observed_generationstring | null
The generation of this Service currently serving traffic. See comments in reconciling for additional information on reconciliation process in Cloud Run. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a string instead of an integer.
- projectstring | null
- reconcilingboolean | null
Returns true if the Service is currently being acted upon by the system to bring it into the desired state. When a new Service is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the Service to the desired serving state. This process is called reconciliation. While reconciliation is in process, observedGeneration, latest_ready_revison, trafficStatuses, and uri will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the Service, or there was an error, and reconciliation failed. This state can be found in terminalCondition.state. If reconciliation succeeded, the following fields will match: traffic and trafficStatuses, observedGeneration and generation, latestReadyRevision and latestCreatedRevision. If reconciliation failed, trafficStatuses, observedGeneration, and latestReadyRevision will have the state of the last serving revision, or empty for newly created Services. Additional information on the failure can be found in terminalCondition and conditions.
- ssh_enabledboolean | null
Enables SSH access to the Service.
- tagsrecord of string | null
A map of resource manager tags. Resource manager tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/{tag_value_id}.
- terminal_conditionobject[] | null
The Condition of this Service, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in reconciling for additional information on reconciliation process in Cloud Run.
Each item
- execution_reasonstring | null
- last_transition_timestring | null
- messagestring | null
- reasonstring | null
- revision_reasonstring | null
- severitystring | null
- statestring | null
- typestring | null
- terraform_labelsrecord of string | null
The combination of labels configured directly on the resource and default labels configured on the provider.
- traffic_statusesobject[] | null
Detailed status information for corresponding traffic targets. See comments in reconciling for additional information on reconciliation process in Cloud Run.
Each item
- percentnumber | null
- revisionstring | null
- tagstring | null
- typestring | null
- uristring | null
- uidstring | null
Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
- update_timestring | null
The last-modified time.
- uristring | null
The main URI in which this Service is serving traffic.
- urlsstring[] | null
All URLs serving traffic for this Service.
- binary_authorizationobject | null
Settings for the Binary Authorization feature.
Fields
- breakglass_justificationstring | null
If present, indicates to use Breakglass using this justification. If useDefault is False, then it must be empty. For more information on breakglass, see https://cloud.google.com/binary-authorization/docs/using-breakglass
- policystring | null
The path to a binary authorization policy. Format: projects/{project}/platforms/cloudRun/{policy-name}
- use_defaultboolean | null
If True, indicates to use the default project's binary authorization policy. If False, binary authorization will be disabled.
- breakglass_justificationstring | null
- build_configobject | null
Configuration for building a Cloud Run function.
Fields
- base_imagestring | null
The base image used to build the function.
- enable_automatic_updatesboolean | null
Sets whether the function will receive automatic base image updates.
- environment_variablesrecord of string | null
User-provided build-time environment variables for the function.
- function_targetstring | null
The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix, if not specified. For backward compatibility, if function with given name is not found, then the system will try to use function named "function".
- image_uristring | null
Artifact Registry URI to store the built image.
- namestring | null
The Cloud Build name of the latest successful deployment of the function.
- service_accountstring | null
Service account to be used for building the container. The format of this field is 'projects/{projectId}/serviceAccounts/{serviceAccountEmail}'.
- source_locationstring | null
The Cloud Storage bucket URI where the function source code is located.
- worker_poolstring | null
Name of the Cloud Build Custom Worker Pool that should be used to build the Cloud Run 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.
- base_imagestring | null
- multi_region_settingsobject | null
Settings for creating a Multi-Region Service. Make sure to use region = 'global' when using them. For more information, visit https://cloud.google.com/run/docs/multiple-regions#deploy
Fields
- multi_region_idstring | null
System-generated unique id for the multi-region Service.
- regionsstring[] | null
The list of regions to deploy the multi-region Service.
- multi_region_idstring | null
- scalingobject | null
Scaling settings that apply to the whole service
Fields
- manual_instance_countnumber | null
Total instance count for the service in manual scaling mode. This number of instances is divided among all revisions with specified traffic based on the percent of traffic they are receiving.
- max_instance_countnumber | null
Combined maximum number of instances for all revisions receiving traffic.
- min_instance_countnumber | null
Minimum number of instances for the service, to be divided among all revisions receiving traffic.
- scaling_modestring | null
The [scaling mode](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#scalingmode) for the service. Possible values: ["AUTOMATIC", "MANUAL"]
- manual_instance_countnumber | null
- templateobjectrequired
The template used to create revisions for this Service.
Fields
- annotationsrecord of string | null
Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with 'run.googleapis.com', 'cloud.googleapis.com', 'serving.knative.dev', or 'autoscaling.knative.dev' namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 RevisionTemplate. This field follows Kubernetes annotations' namespacing, limits, and rules.
- encryption_keystring | null
A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek
- execution_environmentstring | null
The sandbox environment to host this Revision. Possible values: ["EXECUTION_ENVIRONMENT_GEN1", "EXECUTION_ENVIRONMENT_GEN2"]
- gpu_zonal_redundancy_disabledboolean | null
True if GPU zonal redundancy is disabled on this revision.
- health_check_disabledboolean | null
Disables health checking containers during deployment.
- labelsrecord of string | null
Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://docs.cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with 'run.googleapis.com', 'cloud.googleapis.com', 'serving.knative.dev', or 'autoscaling.knative.dev' namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 RevisionTemplate.
- max_instance_request_concurrencynumber | null
Sets the maximum number of requests that each serving instance can receive. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.
- revisionstring | null
The unique name for the revision. If this field is omitted, it will be automatically generated based on the Service name.
- service_accountstring | null
Email address of the IAM service account associated with the revision of the service. The service account represents the identity of the running revision, and determines what permissions the revision has. If not provided, the revision will use the project's default service account.
- session_affinityboolean | null
Enables session affinity. For more information, go to https://cloud.google.com/run/docs/configuring/session-affinity
- timeoutstring | null
Max allowed time for an instance to respond to a request. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
- containersobject[] | null
Holds the containers that define the unit of execution for this Service.
Each item
- argsstring[] | null
Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run.
- base_image_uristring | null
Base image for this container. If set, it indicates that the service is enrolled into automatic base image update.
- build_infoobject[] | null
The build info of the container image.
Each item
- function_targetstring | null
- source_locationstring | null
- commandstring[] | null
Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
- depends_onstring[] | null
Containers which should be started before this container. If specified the container will wait to start until all containers with the listed names are healthy.
- imagestringrequired
URL of the Container image in Google Container Registry or Google Artifact Registry. More info: https://kubernetes.io/docs/concepts/containers/images
- namestring | null
Name of the container specified as a DNS_LABEL.
- sandbox_launcherboolean | null
Indicates that this container can act as a sandbox supervisor and launch sandboxes.
- working_dirstring | null
Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image.
- envobject[] | null
List of environment variables to set in the container.
Each item
- namestringrequired
Name of the environment variable. Must be a C_IDENTIFIER, and may not exceed 32768 characters.
- valuestring | null
Literal value of the environment variable. Defaults to "" and the maximum allowed length is 32768 characters. Variable references are not supported in Cloud Run.
- value_sourceobject | null
Source for the environment variable's value.
Fields
- secret_key_refobject | null
Selects a secret and a specific version from Cloud Secret Manager.
Fields
- secretstringrequired
The name of the secret in Cloud Secret Manager. Format: {secretName} if the secret is in the same project. projects/{project}/secrets/{secretName} if the secret is in a different project.
- versionstring | null
The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version.
- secretstringrequired
- secret_key_refobject | null
- namestringrequired
- liveness_probeobject | null
Periodic probe of container liveness. Container will be restarted if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Fields
- failure_thresholdnumber | null
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
- initial_delay_secondsnumber | null
Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- period_secondsnumber | null
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeoutSeconds
- timeout_secondsnumber | null
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than periodSeconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- grpcobject | null
GRPC specifies an action involving a GRPC port.
Fields
- portnumber | null
Port number to access on the container. Number must be in the range 1 to 65535. If not specified, defaults to the same value as container.ports[0].containerPort.
- servicestring | null
The name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.
- portnumber | null
- http_getobject | null
HTTPGet specifies the http request to perform.
Fields
- pathstring | null
Path to access on the HTTP server. Defaults to '/'.
- portnumber | null
Port number to access on the container. Number must be in the range 1 to 65535. If not specified, defaults to the same value as container.ports[0].containerPort.
- http_headersobject[] | null
Custom headers to set in the request. HTTP allows repeated headers.
Each item
- namestringrequired
The header field name
- valuestring | null
The header field value
- namestringrequired
- pathstring | null
- tcp_socketobject | null
TCPSocketAction describes an action based on opening a socket
Fields
- portnumberrequired
Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
- portnumberrequired
- failure_thresholdnumber | null
- portsobject | null
List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on
Fields
- container_portnumber | null
Port number the container listens on. This must be a valid TCP port number, 0 < containerPort < 65536.
- namestring | null
If specified, used to specify which protocol to use. Allowed values are "http1" and "h2c".
- container_portnumber | null
- readiness_probeobject | null
Periodic probe of container readiness.
Fields
- failure_thresholdnumber | null
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3.
- period_secondsnumber | null
How often (in seconds) to perform the probe. Default to 10 seconds.
- success_thresholdnumber | null
Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 2.
- timeout_secondsnumber | null
Number of seconds after which the probe times out. Defaults to 1 second. Must be smaller than period_seconds.
- grpcobject | null
GRPC specifies an action involving a GRPC port.
Fields
- portnumber | null
Port number to access on the container. Number must be in the range 1 to 65535. If not specified, defaults to the same value as container.ports[0].containerPort.
- servicestring | null
The name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.
- portnumber | null
- http_getobject | null
HttpGet specifies the http request to perform.
Fields
- pathstring | null
Path to access on the HTTP server. If set, it should not be empty string.
- portnumber | null
Port number to access on the container. Number must be in the range 1 to 65535. If not specified, defaults to the same value as container.ports[0].containerPort.
- pathstring | null
- failure_thresholdnumber | null
- resourcesobject | null
Compute Resource requirements by this container. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
Fields
- cpu_idleboolean | null
Determines whether CPU is only allocated during requests. True by default if the parent 'resources' field is not set. However, if 'resources' is set, this field must be explicitly set to true to preserve the default behavior.
- limitsrecord of string | null
Only memory, CPU, and nvidia.com/gpu are supported. Use key 'cpu' for CPU limit, 'memory' for memory limit, 'nvidia.com/gpu' for gpu limit. Note: The only supported values for CPU are '1', '2', '4', '6' and '8'. Setting 4 CPU requires at least 2Gi of memory, setting 6 or more CPU requires at least 4Gi of memory. The values of the map is string form of the 'quantity' k8s type: https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go
- startup_cpu_boostboolean | null
Determines whether CPU should be boosted on startup of a new container instance above the requested CPU threshold, this can help reduce cold-start latency.
- cpu_idleboolean | null
- startup_probeobject | null
Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Fields
- failure_thresholdnumber | null
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
- initial_delay_secondsnumber | null
Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- period_secondsnumber | null
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeoutSeconds
- timeout_secondsnumber | null
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than periodSeconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- grpcobject | null
GRPC specifies an action involving a GRPC port.
Fields
- portnumber | null
Port number to access on the container. Number must be in the range 1 to 65535. If not specified, defaults to the same value as container.ports[0].containerPort.
- servicestring | null
The name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.
- portnumber | null
- http_getobject | null
HTTPGet specifies the http request to perform. Exactly one of HTTPGet or TCPSocket must be specified.
Fields
- pathstring | null
Path to access on the HTTP server. Defaults to '/'.
- portnumber | null
Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the same value as container.ports[0].containerPort.
- http_headersobject[] | null
Custom headers to set in the request. HTTP allows repeated headers.
Each item
- namestringrequired
The header field name
- valuestring | null
The header field value
- namestringrequired
- pathstring | null
- tcp_socketobject | null
TCPSocket specifies an action involving a TCP port. Exactly one of HTTPGet or TCPSocket must be specified.
Fields
- portnumber | null
Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the same value as container.ports[0].containerPort.
- portnumber | null
- failure_thresholdnumber | null
- volume_mountsobject[] | null
Volume to mount into the container's filesystem.
Each item
- mount_pathstringrequired
Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be /cloudsql. All instances defined in the Volume will be available as /cloudsql/[instance]. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run
- namestringrequired
This must match the Name of a Volume.
- sub_pathstring | null
Path within the volume from which the container's volume should be mounted.
- mount_pathstringrequired
- argsstring[] | null
- node_selectorobject | null
Node Selector describes the hardware requirements of the resources.
Fields
- acceleratorstringrequired
The GPU to attach to an instance. See https://cloud.google.com/run/docs/configuring/services/gpu for configuring GPU.
- acceleratorstringrequired
- sandboxesobject | null
Configuration for sandboxes.
Fields
- templatesobject[] | null
Sandbox templates that can be launched through the 'sandbox' CLI.
Each item
- argsstring[] | null
Arguments to the entrypoint. The docker image's CMD is used if this is not provided.
- commandstring[] | null
Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided.
- imagestringrequired
Name of the container image in Dockerhub or Artifact Registry. If the host is not provided, Dockerhub is assumed.
- namestringrequired
Name of the sandbox specified as a DNS_LABEL (RFC 1123).
- working_dirstring | null
Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image.
- envobject[] | null
List of environment variables to set in the sandbox.
Each item
- namestringrequired
Name of the environment variable. Must be a C_IDENTIFIER, and may not exceed 32768 characters.
- valuestring | null
Literal value of the environment variable. Defaults to "" and the maximum allowed length is 32768 characters. Variable references are not supported in Cloud Run.
- namestringrequired
- volume_mountsobject[] | null
Volume to mount into the container's filesystem.
Each item
- mount_pathstringrequired
Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be /cloudsql. All instances defined in the Volume will be available as /cloudsql/[instance]. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run
- namestringrequired
This must match the Name of a Volume.
- sub_pathstring | null
Path within the volume from which the container's volume should be mounted.
- mount_pathstringrequired
- argsstring[] | null
- templatesobject[] | null
- scalingobject | null
Scaling settings for this Revision.
Fields
- concurrency_utilizationnumber | null
Determines a threshold for concurrency utilization before scaling begins. Accepted values are between 0.1 and 0.95 (inclusive) or 0.0 to disable concurrency utilization as threshold for scaling. CPU and concurrency scaling cannot both be disabled.
- cpu_utilizationnumber | null
Determines a threshold for CPU utilization before scaling begins. Accepted values are between 0.1 and 0.95 (inclusive) or 0.0 to disable CPU utilization as threshold for scaling. CPU and concurrency scaling cannot both be disabled.
- max_instance_countnumber | null
Maximum number of serving instances that this resource should have. Must not be less than minimum instance count. If absent, Cloud Run will calculate a default value based on the project's available container instances quota in the region and specified instance size.
- min_instance_countnumber | null
Minimum number of serving instances that this resource should have. Defaults to 0. Must not be greater than maximum instance count.
- concurrency_utilizationnumber | null
- volumesobject[] | null
A list of Volumes to make available to containers.
Each item
- namestringrequired
Volume's name.
- cloud_sql_instanceobject | null
For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
Fields
- instancesstring[] | null
The Cloud SQL instance connection names, as can be found in https://console.cloud.google.com/sql/instances. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. Format: {project}:{location}:{instance}
- instancesstring[] | null
- empty_dirobject | null
Ephemeral storage used as a shared volume.
Fields
- mediumstring | null
The different types of medium supported for EmptyDir. Default value: "MEMORY" Possible values: ["MEMORY", "DISK"]
- size_limitstring | null
Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. This field's values are of the 'Quantity' k8s type: https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/quantity/. The default is nil which means that the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir.
- mediumstring | null
- gcsobject | null
Cloud Storage bucket mounted as a volume using GCSFuse. This feature is only supported in the gen2 execution environment.
Fields
- bucketstringrequired
GCS Bucket name
- mount_optionsstring[] | null
A list of flags to pass to the gcsfuse command for configuring this volume. Flags should be passed without leading dashes.
- read_onlyboolean | null
If true, mount the GCS bucket as read-only
- bucketstringrequired
- nfsobject | null
Represents an NFS mount.
Fields
- pathstringrequired
Path that is exported by the NFS server.
- read_onlyboolean | null
If true, mount the NFS volume as read only
- serverstringrequired
Hostname or IP address of the NFS server
- pathstringrequired
- secretobject | null
Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
Fields
- default_modenumber | null
Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting.
- secretstringrequired
The name of the secret in Cloud Secret Manager. Format: {secret} if the secret is in the same project. projects/{project}/secrets/{secret} if the secret is in a different project.
- itemsobject[] | null
If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version.
Each item
- modenumber | null
Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used.
- pathstringrequired
The relative path of the secret in the container.
- versionstring | null
The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version
- modenumber | null
- default_modenumber | null
- namestringrequired
- vpc_accessobject | null
VPC Access configuration to use for this Task. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.
Fields
- connectorstring | null
VPC Access connector name. Format: projects/{project}/locations/{location}/connectors/{connector}, where {project} can be project id or number.
- egressstring | null
Traffic VPC egress settings. Possible values: ["ALL_TRAFFIC", "PRIVATE_RANGES_ONLY"]
- network_interfacesobject[] | null
Direct VPC egress settings. Currently only single network interface is supported.
Each item
- networkstring | null
The VPC network that the Cloud Run resource will be able to send traffic to. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If network is not specified, it will be looked up from the subnetwork.
- subnetworkstring | null
The VPC subnetwork that the Cloud Run resource will get IPs from. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used.
- tagsstring[] | null
Network tags applied to this Cloud Run service.
- networkstring | null
- connectorstring | null
- workload_identity_configobject | null
The Revision's workload identity settings. Used to assign an [Agent Platform](https://cloud.google.com/run/docs/ai/agent-platform-features) identity to the workload.
Fields
- identitystring | null
The Revision's SPIFFE workload identity. Enables provisioning of SPIFFE workload certificates.
- identity_certificate_enabledboolean | null
Controls whether an instance receives a managed workload identity (MWLID) certificate. Defaults to true when 'identity_type' is 'IDENTITY_TYPE_AGENT_IDENTITY'.
- identity_typestring | null
The type of identity to use. 'IDENTITY_TYPE_AGENT_IDENTITY' assigns a system-managed agent identity and is required when the Service's 'functional_type' is 'FUNCTIONAL_TYPE_AGENT'. Once set, this field cannot be changed or unset. Possible values: ["IDENTITY_TYPE_SERVICE_ACCOUNT", "IDENTITY_TYPE_WORKLOAD_IDENTITY", "IDENTITY_TYPE_AGENT_IDENTITY"]
- identitystring | null
- annotationsrecord of string | null
- timeoutsobject | null
Fields
- createstring | null
- deletestring | null
- updatestring | null
- trafficobject[] | null
Specifies how to distribute traffic over a collection of Revisions belonging to the Service. If traffic is empty or not provided, defaults to 100% traffic to the latest Ready Revision.
Each item
- percentnumber | null
Specifies percent of the traffic to this Revision. This defaults to zero if unspecified.
- revisionstring | null
Revision to which to send this portion of traffic, if traffic allocation is by revision.
- tagstring | null
Indicates a string to be part of the URI to exclusively reference this target.
- typestring | null
The allocation type for this traffic target. Possible values: ["TRAFFIC_TARGET_ALLOCATION_TYPE_LATEST", "TRAFFIC_TARGET_ALLOCATION_TYPE_REVISION"]
- percentnumber | null
- annotationsrecord of string | null
- handlestring
The driver's data for the object, opaque: pass it back unchanged
read
Read a cloud run service as it is now; gone when it no longer exists
Input
- idstringrequired
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
Output
- idstringrequired
at least 1 character
- gonebooleanrequired
- stateobject
Fields
- annotationsrecord of string | null
Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with 'run.googleapis.com', 'cloud.googleapis.com', 'serving.knative.dev', or 'autoscaling.knative.dev' namespaces, and they will be rejected in new resources. All system annotations in v1 now have a corresponding field in v2 Service. This field follows Kubernetes annotations' namespacing, limits, and rules. **Note**: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field 'effective_annotations' for all of the annotations present on the resource.
- clientstring | null
Arbitrary identifier for the API client.
- client_versionstring | null
Arbitrary version identifier for the API client.
- conditionsobject[] | null
The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the Service does not reach its Serving state. See comments in reconciling for additional information on reconciliation process in Cloud Run.
Each item
- execution_reasonstring | null
- last_transition_timestring | null
- messagestring | null
- reasonstring | null
- revision_reasonstring | null
- severitystring | null
- statestring | null
- typestring | null
- create_timestring | null
The creation time.
- creatorstring | null
Email address of the authenticated creator.
- custom_audiencesstring[] | null
One or more custom audiences that you want this service to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences.
- default_uri_disabledboolean | null
Disables public resolution of the default URI of this service.
- delete_timestring | null
The deletion time.
- deletion_policystring | null
Whether Terraform will be prevented from destroying the instance. Defaults to "DELETE". When a 'terraform destroy' or 'terraform apply' would delete the instance, 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.
- deletion_protectionboolean | null
Whether Terraform will be prevented from destroying the service. Defaults to true. When a'terraform destroy' or 'terraform apply' would delete the service, the command will fail if this field is not set to false in Terraform state. When the field is set to true or unset in Terraform state, a 'terraform apply' or 'terraform destroy' that would delete the service will fail. When the field is set to false, deleting the service is allowed.
- descriptionstring | null
User-provided description of the Service. This field currently has a 512-character limit.
- effective_annotationsrecord of string | null
All of annotations (key/value pairs) present on the resource in GCP, including the annotations configured through Terraform, other clients and services.
- effective_labelsrecord of string | null
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Terraform, other clients and services.
- etagstring | null
A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
- expire_timestring | null
For a deleted resource, the time after which it will be permanently deleted.
- generationstring | null
A number that monotonically increases every time the user modifies the desired state. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a string instead of an integer.
- iap_enabledboolean | null
Used to enable/disable IAP for the cloud-run service.
- idstring | null
- ingressstring | null
Provides the ingress settings for this Service. On output, returns the currently observed ingress settings, or INGRESS_TRAFFIC_UNSPECIFIED if no revision is active. Possible values: ["INGRESS_TRAFFIC_ALL", "INGRESS_TRAFFIC_INTERNAL_ONLY", "INGRESS_TRAFFIC_INTERNAL_LOAD_BALANCER"]
- invoker_iam_disabledboolean | null
Disables IAM permission check for run.routes.invoke for callers of this service. For more information, visit https://cloud.google.com/run/docs/securing/managing-access#invoker_check.
- labelsrecord of string | null
Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://docs.cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with 'run.googleapis.com', 'cloud.googleapis.com', 'serving.knative.dev', or 'autoscaling.knative.dev' namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 Service. **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.
- last_modifierstring | null
Email address of the last authenticated modifier.
- latest_created_revisionstring | null
Name of the last created revision. See comments in reconciling for additional information on reconciliation process in Cloud Run.
- latest_ready_revisionstring | null
Name of the latest revision that is serving traffic. See comments in reconciling for additional information on reconciliation process in Cloud Run.
- launch_stagestring | null
The launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/products#product-launch-stages). Cloud Run supports ALPHA, BETA, and GA. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output. Possible values: ["UNIMPLEMENTED", "PRELAUNCH", "EARLY_ACCESS", "ALPHA", "BETA", "GA", "DEPRECATED"]
- locationstringrequired
The location of the cloud run service
- namestringrequired
Name of the Service.
- observed_generationstring | null
The generation of this Service currently serving traffic. See comments in reconciling for additional information on reconciliation process in Cloud Run. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a string instead of an integer.
- projectstring | null
- reconcilingboolean | null
Returns true if the Service is currently being acted upon by the system to bring it into the desired state. When a new Service is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the Service to the desired serving state. This process is called reconciliation. While reconciliation is in process, observedGeneration, latest_ready_revison, trafficStatuses, and uri will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the Service, or there was an error, and reconciliation failed. This state can be found in terminalCondition.state. If reconciliation succeeded, the following fields will match: traffic and trafficStatuses, observedGeneration and generation, latestReadyRevision and latestCreatedRevision. If reconciliation failed, trafficStatuses, observedGeneration, and latestReadyRevision will have the state of the last serving revision, or empty for newly created Services. Additional information on the failure can be found in terminalCondition and conditions.
- ssh_enabledboolean | null
Enables SSH access to the Service.
- tagsrecord of string | null
A map of resource manager tags. Resource manager tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/{tag_value_id}.
- terminal_conditionobject[] | null
The Condition of this Service, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in reconciling for additional information on reconciliation process in Cloud Run.
Each item
- execution_reasonstring | null
- last_transition_timestring | null
- messagestring | null
- reasonstring | null
- revision_reasonstring | null
- severitystring | null
- statestring | null
- typestring | null
- terraform_labelsrecord of string | null
The combination of labels configured directly on the resource and default labels configured on the provider.
- traffic_statusesobject[] | null
Detailed status information for corresponding traffic targets. See comments in reconciling for additional information on reconciliation process in Cloud Run.
Each item
- percentnumber | null
- revisionstring | null
- tagstring | null
- typestring | null
- uristring | null
- uidstring | null
Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
- update_timestring | null
The last-modified time.
- uristring | null
The main URI in which this Service is serving traffic.
- urlsstring[] | null
All URLs serving traffic for this Service.
- binary_authorizationobject | null
Settings for the Binary Authorization feature.
Fields
- breakglass_justificationstring | null
If present, indicates to use Breakglass using this justification. If useDefault is False, then it must be empty. For more information on breakglass, see https://cloud.google.com/binary-authorization/docs/using-breakglass
- policystring | null
The path to a binary authorization policy. Format: projects/{project}/platforms/cloudRun/{policy-name}
- use_defaultboolean | null
If True, indicates to use the default project's binary authorization policy. If False, binary authorization will be disabled.
- breakglass_justificationstring | null
- build_configobject | null
Configuration for building a Cloud Run function.
Fields
- base_imagestring | null
The base image used to build the function.
- enable_automatic_updatesboolean | null
Sets whether the function will receive automatic base image updates.
- environment_variablesrecord of string | null
User-provided build-time environment variables for the function.
- function_targetstring | null
The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix, if not specified. For backward compatibility, if function with given name is not found, then the system will try to use function named "function".
- image_uristring | null
Artifact Registry URI to store the built image.
- namestring | null
The Cloud Build name of the latest successful deployment of the function.
- service_accountstring | null
Service account to be used for building the container. The format of this field is 'projects/{projectId}/serviceAccounts/{serviceAccountEmail}'.
- source_locationstring | null
The Cloud Storage bucket URI where the function source code is located.
- worker_poolstring | null
Name of the Cloud Build Custom Worker Pool that should be used to build the Cloud Run 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.
- base_imagestring | null
- multi_region_settingsobject | null
Settings for creating a Multi-Region Service. Make sure to use region = 'global' when using them. For more information, visit https://cloud.google.com/run/docs/multiple-regions#deploy
Fields
- multi_region_idstring | null
System-generated unique id for the multi-region Service.
- regionsstring[] | null
The list of regions to deploy the multi-region Service.
- multi_region_idstring | null
- scalingobject | null
Scaling settings that apply to the whole service
Fields
- manual_instance_countnumber | null
Total instance count for the service in manual scaling mode. This number of instances is divided among all revisions with specified traffic based on the percent of traffic they are receiving.
- max_instance_countnumber | null
Combined maximum number of instances for all revisions receiving traffic.
- min_instance_countnumber | null
Minimum number of instances for the service, to be divided among all revisions receiving traffic.
- scaling_modestring | null
The [scaling mode](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#scalingmode) for the service. Possible values: ["AUTOMATIC", "MANUAL"]
- manual_instance_countnumber | null
- templateobjectrequired
The template used to create revisions for this Service.
Fields
- annotationsrecord of string | null
Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with 'run.googleapis.com', 'cloud.googleapis.com', 'serving.knative.dev', or 'autoscaling.knative.dev' namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 RevisionTemplate. This field follows Kubernetes annotations' namespacing, limits, and rules.
- encryption_keystring | null
A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek
- execution_environmentstring | null
The sandbox environment to host this Revision. Possible values: ["EXECUTION_ENVIRONMENT_GEN1", "EXECUTION_ENVIRONMENT_GEN2"]
- gpu_zonal_redundancy_disabledboolean | null
True if GPU zonal redundancy is disabled on this revision.
- health_check_disabledboolean | null
Disables health checking containers during deployment.
- labelsrecord of string | null
Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://docs.cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with 'run.googleapis.com', 'cloud.googleapis.com', 'serving.knative.dev', or 'autoscaling.knative.dev' namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 RevisionTemplate.
- max_instance_request_concurrencynumber | null
Sets the maximum number of requests that each serving instance can receive. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.
- revisionstring | null
The unique name for the revision. If this field is omitted, it will be automatically generated based on the Service name.
- service_accountstring | null
Email address of the IAM service account associated with the revision of the service. The service account represents the identity of the running revision, and determines what permissions the revision has. If not provided, the revision will use the project's default service account.
- session_affinityboolean | null
Enables session affinity. For more information, go to https://cloud.google.com/run/docs/configuring/session-affinity
- timeoutstring | null
Max allowed time for an instance to respond to a request. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
- containersobject[] | null
Holds the containers that define the unit of execution for this Service.
Each item
- argsstring[] | null
Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run.
- base_image_uristring | null
Base image for this container. If set, it indicates that the service is enrolled into automatic base image update.
- build_infoobject[] | null
The build info of the container image.
Each item
- function_targetstring | null
- source_locationstring | null
- commandstring[] | null
Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
- depends_onstring[] | null
Containers which should be started before this container. If specified the container will wait to start until all containers with the listed names are healthy.
- imagestringrequired
URL of the Container image in Google Container Registry or Google Artifact Registry. More info: https://kubernetes.io/docs/concepts/containers/images
- namestring | null
Name of the container specified as a DNS_LABEL.
- sandbox_launcherboolean | null
Indicates that this container can act as a sandbox supervisor and launch sandboxes.
- working_dirstring | null
Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image.
- envobject[] | null
List of environment variables to set in the container.
Each item
- namestringrequired
Name of the environment variable. Must be a C_IDENTIFIER, and may not exceed 32768 characters.
- valuestring | null
Literal value of the environment variable. Defaults to "" and the maximum allowed length is 32768 characters. Variable references are not supported in Cloud Run.
- value_sourceobject | null
Source for the environment variable's value.
Fields
- secret_key_refobject | null
Selects a secret and a specific version from Cloud Secret Manager.
Fields
- secretstringrequired
The name of the secret in Cloud Secret Manager. Format: {secretName} if the secret is in the same project. projects/{project}/secrets/{secretName} if the secret is in a different project.
- versionstring | null
The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version.
- secretstringrequired
- secret_key_refobject | null
- namestringrequired
- liveness_probeobject | null
Periodic probe of container liveness. Container will be restarted if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Fields
- failure_thresholdnumber | null
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
- initial_delay_secondsnumber | null
Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- period_secondsnumber | null
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeoutSeconds
- timeout_secondsnumber | null
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than periodSeconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- grpcobject | null
GRPC specifies an action involving a GRPC port.
Fields
- portnumber | null
Port number to access on the container. Number must be in the range 1 to 65535. If not specified, defaults to the same value as container.ports[0].containerPort.
- servicestring | null
The name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.
- portnumber | null
- http_getobject | null
HTTPGet specifies the http request to perform.
Fields
- pathstring | null
Path to access on the HTTP server. Defaults to '/'.
- portnumber | null
Port number to access on the container. Number must be in the range 1 to 65535. If not specified, defaults to the same value as container.ports[0].containerPort.
- http_headersobject[] | null
Custom headers to set in the request. HTTP allows repeated headers.
Each item
- namestringrequired
The header field name
- valuestring | null
The header field value
- namestringrequired
- pathstring | null
- tcp_socketobject | null
TCPSocketAction describes an action based on opening a socket
Fields
- portnumberrequired
Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
- portnumberrequired
- failure_thresholdnumber | null
- portsobject | null
List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on
Fields
- container_portnumber | null
Port number the container listens on. This must be a valid TCP port number, 0 < containerPort < 65536.
- namestring | null
If specified, used to specify which protocol to use. Allowed values are "http1" and "h2c".
- container_portnumber | null
- readiness_probeobject | null
Periodic probe of container readiness.
Fields
- failure_thresholdnumber | null
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3.
- period_secondsnumber | null
How often (in seconds) to perform the probe. Default to 10 seconds.
- success_thresholdnumber | null
Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 2.
- timeout_secondsnumber | null
Number of seconds after which the probe times out. Defaults to 1 second. Must be smaller than period_seconds.
- grpcobject | null
GRPC specifies an action involving a GRPC port.
Fields
- portnumber | null
Port number to access on the container. Number must be in the range 1 to 65535. If not specified, defaults to the same value as container.ports[0].containerPort.
- servicestring | null
The name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.
- portnumber | null
- http_getobject | null
HttpGet specifies the http request to perform.
Fields
- pathstring | null
Path to access on the HTTP server. If set, it should not be empty string.
- portnumber | null
Port number to access on the container. Number must be in the range 1 to 65535. If not specified, defaults to the same value as container.ports[0].containerPort.
- pathstring | null
- failure_thresholdnumber | null
- resourcesobject | null
Compute Resource requirements by this container. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
Fields
- cpu_idleboolean | null
Determines whether CPU is only allocated during requests. True by default if the parent 'resources' field is not set. However, if 'resources' is set, this field must be explicitly set to true to preserve the default behavior.
- limitsrecord of string | null
Only memory, CPU, and nvidia.com/gpu are supported. Use key 'cpu' for CPU limit, 'memory' for memory limit, 'nvidia.com/gpu' for gpu limit. Note: The only supported values for CPU are '1', '2', '4', '6' and '8'. Setting 4 CPU requires at least 2Gi of memory, setting 6 or more CPU requires at least 4Gi of memory. The values of the map is string form of the 'quantity' k8s type: https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go
- startup_cpu_boostboolean | null
Determines whether CPU should be boosted on startup of a new container instance above the requested CPU threshold, this can help reduce cold-start latency.
- cpu_idleboolean | null
- startup_probeobject | null
Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Fields
- failure_thresholdnumber | null
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
- initial_delay_secondsnumber | null
Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- period_secondsnumber | null
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeoutSeconds
- timeout_secondsnumber | null
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than periodSeconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- grpcobject | null
GRPC specifies an action involving a GRPC port.
Fields
- portnumber | null
Port number to access on the container. Number must be in the range 1 to 65535. If not specified, defaults to the same value as container.ports[0].containerPort.
- servicestring | null
The name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.
- portnumber | null
- http_getobject | null
HTTPGet specifies the http request to perform. Exactly one of HTTPGet or TCPSocket must be specified.
Fields
- pathstring | null
Path to access on the HTTP server. Defaults to '/'.
- portnumber | null
Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the same value as container.ports[0].containerPort.
- http_headersobject[] | null
Custom headers to set in the request. HTTP allows repeated headers.
Each item
- namestringrequired
The header field name
- valuestring | null
The header field value
- namestringrequired
- pathstring | null
- tcp_socketobject | null
TCPSocket specifies an action involving a TCP port. Exactly one of HTTPGet or TCPSocket must be specified.
Fields
- portnumber | null
Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the same value as container.ports[0].containerPort.
- portnumber | null
- failure_thresholdnumber | null
- volume_mountsobject[] | null
Volume to mount into the container's filesystem.
Each item
- mount_pathstringrequired
Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be /cloudsql. All instances defined in the Volume will be available as /cloudsql/[instance]. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run
- namestringrequired
This must match the Name of a Volume.
- sub_pathstring | null
Path within the volume from which the container's volume should be mounted.
- mount_pathstringrequired
- argsstring[] | null
- node_selectorobject | null
Node Selector describes the hardware requirements of the resources.
Fields
- acceleratorstringrequired
The GPU to attach to an instance. See https://cloud.google.com/run/docs/configuring/services/gpu for configuring GPU.
- acceleratorstringrequired
- sandboxesobject | null
Configuration for sandboxes.
Fields
- templatesobject[] | null
Sandbox templates that can be launched through the 'sandbox' CLI.
Each item
- argsstring[] | null
Arguments to the entrypoint. The docker image's CMD is used if this is not provided.
- commandstring[] | null
Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided.
- imagestringrequired
Name of the container image in Dockerhub or Artifact Registry. If the host is not provided, Dockerhub is assumed.
- namestringrequired
Name of the sandbox specified as a DNS_LABEL (RFC 1123).
- working_dirstring | null
Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image.
- envobject[] | null
List of environment variables to set in the sandbox.
Each item
- namestringrequired
Name of the environment variable. Must be a C_IDENTIFIER, and may not exceed 32768 characters.
- valuestring | null
Literal value of the environment variable. Defaults to "" and the maximum allowed length is 32768 characters. Variable references are not supported in Cloud Run.
- namestringrequired
- volume_mountsobject[] | null
Volume to mount into the container's filesystem.
Each item
- mount_pathstringrequired
Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be /cloudsql. All instances defined in the Volume will be available as /cloudsql/[instance]. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run
- namestringrequired
This must match the Name of a Volume.
- sub_pathstring | null
Path within the volume from which the container's volume should be mounted.
- mount_pathstringrequired
- argsstring[] | null
- templatesobject[] | null
- scalingobject | null
Scaling settings for this Revision.
Fields
- concurrency_utilizationnumber | null
Determines a threshold for concurrency utilization before scaling begins. Accepted values are between 0.1 and 0.95 (inclusive) or 0.0 to disable concurrency utilization as threshold for scaling. CPU and concurrency scaling cannot both be disabled.
- cpu_utilizationnumber | null
Determines a threshold for CPU utilization before scaling begins. Accepted values are between 0.1 and 0.95 (inclusive) or 0.0 to disable CPU utilization as threshold for scaling. CPU and concurrency scaling cannot both be disabled.
- max_instance_countnumber | null
Maximum number of serving instances that this resource should have. Must not be less than minimum instance count. If absent, Cloud Run will calculate a default value based on the project's available container instances quota in the region and specified instance size.
- min_instance_countnumber | null
Minimum number of serving instances that this resource should have. Defaults to 0. Must not be greater than maximum instance count.
- concurrency_utilizationnumber | null
- volumesobject[] | null
A list of Volumes to make available to containers.
Each item
- namestringrequired
Volume's name.
- cloud_sql_instanceobject | null
For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
Fields
- instancesstring[] | null
The Cloud SQL instance connection names, as can be found in https://console.cloud.google.com/sql/instances. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. Format: {project}:{location}:{instance}
- instancesstring[] | null
- empty_dirobject | null
Ephemeral storage used as a shared volume.
Fields
- mediumstring | null
The different types of medium supported for EmptyDir. Default value: "MEMORY" Possible values: ["MEMORY", "DISK"]
- size_limitstring | null
Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. This field's values are of the 'Quantity' k8s type: https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/quantity/. The default is nil which means that the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir.
- mediumstring | null
- gcsobject | null
Cloud Storage bucket mounted as a volume using GCSFuse. This feature is only supported in the gen2 execution environment.
Fields
- bucketstringrequired
GCS Bucket name
- mount_optionsstring[] | null
A list of flags to pass to the gcsfuse command for configuring this volume. Flags should be passed without leading dashes.
- read_onlyboolean | null
If true, mount the GCS bucket as read-only
- bucketstringrequired
- nfsobject | null
Represents an NFS mount.
Fields
- pathstringrequired
Path that is exported by the NFS server.
- read_onlyboolean | null
If true, mount the NFS volume as read only
- serverstringrequired
Hostname or IP address of the NFS server
- pathstringrequired
- secretobject | null
Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
Fields
- default_modenumber | null
Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting.
- secretstringrequired
The name of the secret in Cloud Secret Manager. Format: {secret} if the secret is in the same project. projects/{project}/secrets/{secret} if the secret is in a different project.
- itemsobject[] | null
If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version.
Each item
- modenumber | null
Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used.
- pathstringrequired
The relative path of the secret in the container.
- versionstring | null
The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version
- modenumber | null
- default_modenumber | null
- namestringrequired
- vpc_accessobject | null
VPC Access configuration to use for this Task. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.
Fields
- connectorstring | null
VPC Access connector name. Format: projects/{project}/locations/{location}/connectors/{connector}, where {project} can be project id or number.
- egressstring | null
Traffic VPC egress settings. Possible values: ["ALL_TRAFFIC", "PRIVATE_RANGES_ONLY"]
- network_interfacesobject[] | null
Direct VPC egress settings. Currently only single network interface is supported.
Each item
- networkstring | null
The VPC network that the Cloud Run resource will be able to send traffic to. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If network is not specified, it will be looked up from the subnetwork.
- subnetworkstring | null
The VPC subnetwork that the Cloud Run resource will get IPs from. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used.
- tagsstring[] | null
Network tags applied to this Cloud Run service.
- networkstring | null
- connectorstring | null
- workload_identity_configobject | null
The Revision's workload identity settings. Used to assign an [Agent Platform](https://cloud.google.com/run/docs/ai/agent-platform-features) identity to the workload.
Fields
- identitystring | null
The Revision's SPIFFE workload identity. Enables provisioning of SPIFFE workload certificates.
- identity_certificate_enabledboolean | null
Controls whether an instance receives a managed workload identity (MWLID) certificate. Defaults to true when 'identity_type' is 'IDENTITY_TYPE_AGENT_IDENTITY'.
- identity_typestring | null
The type of identity to use. 'IDENTITY_TYPE_AGENT_IDENTITY' assigns a system-managed agent identity and is required when the Service's 'functional_type' is 'FUNCTIONAL_TYPE_AGENT'. Once set, this field cannot be changed or unset. Possible values: ["IDENTITY_TYPE_SERVICE_ACCOUNT", "IDENTITY_TYPE_WORKLOAD_IDENTITY", "IDENTITY_TYPE_AGENT_IDENTITY"]
- identitystring | null
- annotationsrecord of string | null
- timeoutsobject | null
Fields
- createstring | null
- deletestring | null
- updatestring | null
- trafficobject[] | null
Specifies how to distribute traffic over a collection of Revisions belonging to the Service. If traffic is empty or not provided, defaults to 100% traffic to the latest Ready Revision.
Each item
- percentnumber | null
Specifies percent of the traffic to this Revision. This defaults to zero if unspecified.
- revisionstring | null
Revision to which to send this portion of traffic, if traffic allocation is by revision.
- tagstring | null
Indicates a string to be part of the URI to exclusively reference this target.
- typestring | null
The allocation type for this traffic target. Possible values: ["TRAFFIC_TARGET_ALLOCATION_TYPE_LATEST", "TRAFFIC_TARGET_ALLOCATION_TYPE_REVISION"]
- percentnumber | null
- annotationsrecord of string | null
- handlestring
The driver's data for the object, opaque: pass it back unchanged
plan
Plan how apply would make a cloud run service match its declaration (or delete it, given none); nothing changes
Input
- idstring
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
- desiredrecord of any
The declared fields; a write-only one may hold a secret marker
Output
- action"none" | "create" | "update" | "replace" | "delete"required
- plannedrecord of any
- unknownstring[]required
- replacestring[]required
The fields whose change replaces the object: not empty exactly when
replace
create
Create a cloud run service as declared
Input
- desiredrecord of anyrequired
The declared fields; a write-only one may hold a secret marker
Output
- idstringrequired
at least 1 character
- stateobjectrequired
Fields
- annotationsrecord of string | null
Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with 'run.googleapis.com', 'cloud.googleapis.com', 'serving.knative.dev', or 'autoscaling.knative.dev' namespaces, and they will be rejected in new resources. All system annotations in v1 now have a corresponding field in v2 Service. This field follows Kubernetes annotations' namespacing, limits, and rules. **Note**: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field 'effective_annotations' for all of the annotations present on the resource.
- clientstring | null
Arbitrary identifier for the API client.
- client_versionstring | null
Arbitrary version identifier for the API client.
- conditionsobject[] | null
The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the Service does not reach its Serving state. See comments in reconciling for additional information on reconciliation process in Cloud Run.
Each item
- execution_reasonstring | null
- last_transition_timestring | null
- messagestring | null
- reasonstring | null
- revision_reasonstring | null
- severitystring | null
- statestring | null
- typestring | null
- create_timestring | null
The creation time.
- creatorstring | null
Email address of the authenticated creator.
- custom_audiencesstring[] | null
One or more custom audiences that you want this service to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences.
- default_uri_disabledboolean | null
Disables public resolution of the default URI of this service.
- delete_timestring | null
The deletion time.
- deletion_policystring | null
Whether Terraform will be prevented from destroying the instance. Defaults to "DELETE". When a 'terraform destroy' or 'terraform apply' would delete the instance, 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.
- deletion_protectionboolean | null
Whether Terraform will be prevented from destroying the service. Defaults to true. When a'terraform destroy' or 'terraform apply' would delete the service, the command will fail if this field is not set to false in Terraform state. When the field is set to true or unset in Terraform state, a 'terraform apply' or 'terraform destroy' that would delete the service will fail. When the field is set to false, deleting the service is allowed.
- descriptionstring | null
User-provided description of the Service. This field currently has a 512-character limit.
- effective_annotationsrecord of string | null
All of annotations (key/value pairs) present on the resource in GCP, including the annotations configured through Terraform, other clients and services.
- effective_labelsrecord of string | null
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Terraform, other clients and services.
- etagstring | null
A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
- expire_timestring | null
For a deleted resource, the time after which it will be permanently deleted.
- generationstring | null
A number that monotonically increases every time the user modifies the desired state. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a string instead of an integer.
- iap_enabledboolean | null
Used to enable/disable IAP for the cloud-run service.
- idstring | null
- ingressstring | null
Provides the ingress settings for this Service. On output, returns the currently observed ingress settings, or INGRESS_TRAFFIC_UNSPECIFIED if no revision is active. Possible values: ["INGRESS_TRAFFIC_ALL", "INGRESS_TRAFFIC_INTERNAL_ONLY", "INGRESS_TRAFFIC_INTERNAL_LOAD_BALANCER"]
- invoker_iam_disabledboolean | null
Disables IAM permission check for run.routes.invoke for callers of this service. For more information, visit https://cloud.google.com/run/docs/securing/managing-access#invoker_check.
- labelsrecord of string | null
Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://docs.cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with 'run.googleapis.com', 'cloud.googleapis.com', 'serving.knative.dev', or 'autoscaling.knative.dev' namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 Service. **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.
- last_modifierstring | null
Email address of the last authenticated modifier.
- latest_created_revisionstring | null
Name of the last created revision. See comments in reconciling for additional information on reconciliation process in Cloud Run.
- latest_ready_revisionstring | null
Name of the latest revision that is serving traffic. See comments in reconciling for additional information on reconciliation process in Cloud Run.
- launch_stagestring | null
The launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/products#product-launch-stages). Cloud Run supports ALPHA, BETA, and GA. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output. Possible values: ["UNIMPLEMENTED", "PRELAUNCH", "EARLY_ACCESS", "ALPHA", "BETA", "GA", "DEPRECATED"]
- locationstringrequired
The location of the cloud run service
- namestringrequired
Name of the Service.
- observed_generationstring | null
The generation of this Service currently serving traffic. See comments in reconciling for additional information on reconciliation process in Cloud Run. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a string instead of an integer.
- projectstring | null
- reconcilingboolean | null
Returns true if the Service is currently being acted upon by the system to bring it into the desired state. When a new Service is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the Service to the desired serving state. This process is called reconciliation. While reconciliation is in process, observedGeneration, latest_ready_revison, trafficStatuses, and uri will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the Service, or there was an error, and reconciliation failed. This state can be found in terminalCondition.state. If reconciliation succeeded, the following fields will match: traffic and trafficStatuses, observedGeneration and generation, latestReadyRevision and latestCreatedRevision. If reconciliation failed, trafficStatuses, observedGeneration, and latestReadyRevision will have the state of the last serving revision, or empty for newly created Services. Additional information on the failure can be found in terminalCondition and conditions.
- ssh_enabledboolean | null
Enables SSH access to the Service.
- tagsrecord of string | null
A map of resource manager tags. Resource manager tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/{tag_value_id}.
- terminal_conditionobject[] | null
The Condition of this Service, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in reconciling for additional information on reconciliation process in Cloud Run.
Each item
- execution_reasonstring | null
- last_transition_timestring | null
- messagestring | null
- reasonstring | null
- revision_reasonstring | null
- severitystring | null
- statestring | null
- typestring | null
- terraform_labelsrecord of string | null
The combination of labels configured directly on the resource and default labels configured on the provider.
- traffic_statusesobject[] | null
Detailed status information for corresponding traffic targets. See comments in reconciling for additional information on reconciliation process in Cloud Run.
Each item
- percentnumber | null
- revisionstring | null
- tagstring | null
- typestring | null
- uristring | null
- uidstring | null
Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
- update_timestring | null
The last-modified time.
- uristring | null
The main URI in which this Service is serving traffic.
- urlsstring[] | null
All URLs serving traffic for this Service.
- binary_authorizationobject | null
Settings for the Binary Authorization feature.
Fields
- breakglass_justificationstring | null
If present, indicates to use Breakglass using this justification. If useDefault is False, then it must be empty. For more information on breakglass, see https://cloud.google.com/binary-authorization/docs/using-breakglass
- policystring | null
The path to a binary authorization policy. Format: projects/{project}/platforms/cloudRun/{policy-name}
- use_defaultboolean | null
If True, indicates to use the default project's binary authorization policy. If False, binary authorization will be disabled.
- breakglass_justificationstring | null
- build_configobject | null
Configuration for building a Cloud Run function.
Fields
- base_imagestring | null
The base image used to build the function.
- enable_automatic_updatesboolean | null
Sets whether the function will receive automatic base image updates.
- environment_variablesrecord of string | null
User-provided build-time environment variables for the function.
- function_targetstring | null
The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix, if not specified. For backward compatibility, if function with given name is not found, then the system will try to use function named "function".
- image_uristring | null
Artifact Registry URI to store the built image.
- namestring | null
The Cloud Build name of the latest successful deployment of the function.
- service_accountstring | null
Service account to be used for building the container. The format of this field is 'projects/{projectId}/serviceAccounts/{serviceAccountEmail}'.
- source_locationstring | null
The Cloud Storage bucket URI where the function source code is located.
- worker_poolstring | null
Name of the Cloud Build Custom Worker Pool that should be used to build the Cloud Run 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.
- base_imagestring | null
- multi_region_settingsobject | null
Settings for creating a Multi-Region Service. Make sure to use region = 'global' when using them. For more information, visit https://cloud.google.com/run/docs/multiple-regions#deploy
Fields
- multi_region_idstring | null
System-generated unique id for the multi-region Service.
- regionsstring[] | null
The list of regions to deploy the multi-region Service.
- multi_region_idstring | null
- scalingobject | null
Scaling settings that apply to the whole service
Fields
- manual_instance_countnumber | null
Total instance count for the service in manual scaling mode. This number of instances is divided among all revisions with specified traffic based on the percent of traffic they are receiving.
- max_instance_countnumber | null
Combined maximum number of instances for all revisions receiving traffic.
- min_instance_countnumber | null
Minimum number of instances for the service, to be divided among all revisions receiving traffic.
- scaling_modestring | null
The [scaling mode](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#scalingmode) for the service. Possible values: ["AUTOMATIC", "MANUAL"]
- manual_instance_countnumber | null
- templateobjectrequired
The template used to create revisions for this Service.
Fields
- annotationsrecord of string | null
Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with 'run.googleapis.com', 'cloud.googleapis.com', 'serving.knative.dev', or 'autoscaling.knative.dev' namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 RevisionTemplate. This field follows Kubernetes annotations' namespacing, limits, and rules.
- encryption_keystring | null
A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek
- execution_environmentstring | null
The sandbox environment to host this Revision. Possible values: ["EXECUTION_ENVIRONMENT_GEN1", "EXECUTION_ENVIRONMENT_GEN2"]
- gpu_zonal_redundancy_disabledboolean | null
True if GPU zonal redundancy is disabled on this revision.
- health_check_disabledboolean | null
Disables health checking containers during deployment.
- labelsrecord of string | null
Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://docs.cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with 'run.googleapis.com', 'cloud.googleapis.com', 'serving.knative.dev', or 'autoscaling.knative.dev' namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 RevisionTemplate.
- max_instance_request_concurrencynumber | null
Sets the maximum number of requests that each serving instance can receive. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.
- revisionstring | null
The unique name for the revision. If this field is omitted, it will be automatically generated based on the Service name.
- service_accountstring | null
Email address of the IAM service account associated with the revision of the service. The service account represents the identity of the running revision, and determines what permissions the revision has. If not provided, the revision will use the project's default service account.
- session_affinityboolean | null
Enables session affinity. For more information, go to https://cloud.google.com/run/docs/configuring/session-affinity
- timeoutstring | null
Max allowed time for an instance to respond to a request. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
- containersobject[] | null
Holds the containers that define the unit of execution for this Service.
Each item
- argsstring[] | null
Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run.
- base_image_uristring | null
Base image for this container. If set, it indicates that the service is enrolled into automatic base image update.
- build_infoobject[] | null
The build info of the container image.
Each item
- function_targetstring | null
- source_locationstring | null
- commandstring[] | null
Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
- depends_onstring[] | null
Containers which should be started before this container. If specified the container will wait to start until all containers with the listed names are healthy.
- imagestringrequired
URL of the Container image in Google Container Registry or Google Artifact Registry. More info: https://kubernetes.io/docs/concepts/containers/images
- namestring | null
Name of the container specified as a DNS_LABEL.
- sandbox_launcherboolean | null
Indicates that this container can act as a sandbox supervisor and launch sandboxes.
- working_dirstring | null
Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image.
- envobject[] | null
List of environment variables to set in the container.
Each item
- namestringrequired
Name of the environment variable. Must be a C_IDENTIFIER, and may not exceed 32768 characters.
- valuestring | null
Literal value of the environment variable. Defaults to "" and the maximum allowed length is 32768 characters. Variable references are not supported in Cloud Run.
- value_sourceobject | null
Source for the environment variable's value.
Fields
- secret_key_refobject | null
Selects a secret and a specific version from Cloud Secret Manager.
Fields
- secretstringrequired
The name of the secret in Cloud Secret Manager. Format: {secretName} if the secret is in the same project. projects/{project}/secrets/{secretName} if the secret is in a different project.
- versionstring | null
The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version.
- secretstringrequired
- secret_key_refobject | null
- namestringrequired
- liveness_probeobject | null
Periodic probe of container liveness. Container will be restarted if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Fields
- failure_thresholdnumber | null
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
- initial_delay_secondsnumber | null
Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- period_secondsnumber | null
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeoutSeconds
- timeout_secondsnumber | null
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than periodSeconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- grpcobject | null
GRPC specifies an action involving a GRPC port.
Fields
- portnumber | null
Port number to access on the container. Number must be in the range 1 to 65535. If not specified, defaults to the same value as container.ports[0].containerPort.
- servicestring | null
The name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.
- portnumber | null
- http_getobject | null
HTTPGet specifies the http request to perform.
Fields
- pathstring | null
Path to access on the HTTP server. Defaults to '/'.
- portnumber | null
Port number to access on the container. Number must be in the range 1 to 65535. If not specified, defaults to the same value as container.ports[0].containerPort.
- http_headersobject[] | null
Custom headers to set in the request. HTTP allows repeated headers.
Each item
- namestringrequired
The header field name
- valuestring | null
The header field value
- namestringrequired
- pathstring | null
- tcp_socketobject | null
TCPSocketAction describes an action based on opening a socket
Fields
- portnumberrequired
Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
- portnumberrequired
- failure_thresholdnumber | null
- portsobject | null
List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on
Fields
- container_portnumber | null
Port number the container listens on. This must be a valid TCP port number, 0 < containerPort < 65536.
- namestring | null
If specified, used to specify which protocol to use. Allowed values are "http1" and "h2c".
- container_portnumber | null
- readiness_probeobject | null
Periodic probe of container readiness.
Fields
- failure_thresholdnumber | null
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3.
- period_secondsnumber | null
How often (in seconds) to perform the probe. Default to 10 seconds.
- success_thresholdnumber | null
Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 2.
- timeout_secondsnumber | null
Number of seconds after which the probe times out. Defaults to 1 second. Must be smaller than period_seconds.
- grpcobject | null
GRPC specifies an action involving a GRPC port.
Fields
- portnumber | null
Port number to access on the container. Number must be in the range 1 to 65535. If not specified, defaults to the same value as container.ports[0].containerPort.
- servicestring | null
The name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.
- portnumber | null
- http_getobject | null
HttpGet specifies the http request to perform.
Fields
- pathstring | null
Path to access on the HTTP server. If set, it should not be empty string.
- portnumber | null
Port number to access on the container. Number must be in the range 1 to 65535. If not specified, defaults to the same value as container.ports[0].containerPort.
- pathstring | null
- failure_thresholdnumber | null
- resourcesobject | null
Compute Resource requirements by this container. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
Fields
- cpu_idleboolean | null
Determines whether CPU is only allocated during requests. True by default if the parent 'resources' field is not set. However, if 'resources' is set, this field must be explicitly set to true to preserve the default behavior.
- limitsrecord of string | null
Only memory, CPU, and nvidia.com/gpu are supported. Use key 'cpu' for CPU limit, 'memory' for memory limit, 'nvidia.com/gpu' for gpu limit. Note: The only supported values for CPU are '1', '2', '4', '6' and '8'. Setting 4 CPU requires at least 2Gi of memory, setting 6 or more CPU requires at least 4Gi of memory. The values of the map is string form of the 'quantity' k8s type: https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go
- startup_cpu_boostboolean | null
Determines whether CPU should be boosted on startup of a new container instance above the requested CPU threshold, this can help reduce cold-start latency.
- cpu_idleboolean | null
- startup_probeobject | null
Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Fields
- failure_thresholdnumber | null
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
- initial_delay_secondsnumber | null
Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- period_secondsnumber | null
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeoutSeconds
- timeout_secondsnumber | null
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than periodSeconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- grpcobject | null
GRPC specifies an action involving a GRPC port.
Fields
- portnumber | null
Port number to access on the container. Number must be in the range 1 to 65535. If not specified, defaults to the same value as container.ports[0].containerPort.
- servicestring | null
The name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.
- portnumber | null
- http_getobject | null
HTTPGet specifies the http request to perform. Exactly one of HTTPGet or TCPSocket must be specified.
Fields
- pathstring | null
Path to access on the HTTP server. Defaults to '/'.
- portnumber | null
Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the same value as container.ports[0].containerPort.
- http_headersobject[] | null
Custom headers to set in the request. HTTP allows repeated headers.
Each item
- namestringrequired
The header field name
- valuestring | null
The header field value
- namestringrequired
- pathstring | null
- tcp_socketobject | null
TCPSocket specifies an action involving a TCP port. Exactly one of HTTPGet or TCPSocket must be specified.
Fields
- portnumber | null
Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the same value as container.ports[0].containerPort.
- portnumber | null
- failure_thresholdnumber | null
- volume_mountsobject[] | null
Volume to mount into the container's filesystem.
Each item
- mount_pathstringrequired
Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be /cloudsql. All instances defined in the Volume will be available as /cloudsql/[instance]. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run
- namestringrequired
This must match the Name of a Volume.
- sub_pathstring | null
Path within the volume from which the container's volume should be mounted.
- mount_pathstringrequired
- argsstring[] | null
- node_selectorobject | null
Node Selector describes the hardware requirements of the resources.
Fields
- acceleratorstringrequired
The GPU to attach to an instance. See https://cloud.google.com/run/docs/configuring/services/gpu for configuring GPU.
- acceleratorstringrequired
- sandboxesobject | null
Configuration for sandboxes.
Fields
- templatesobject[] | null
Sandbox templates that can be launched through the 'sandbox' CLI.
Each item
- argsstring[] | null
Arguments to the entrypoint. The docker image's CMD is used if this is not provided.
- commandstring[] | null
Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided.
- imagestringrequired
Name of the container image in Dockerhub or Artifact Registry. If the host is not provided, Dockerhub is assumed.
- namestringrequired
Name of the sandbox specified as a DNS_LABEL (RFC 1123).
- working_dirstring | null
Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image.
- envobject[] | null
List of environment variables to set in the sandbox.
Each item
- namestringrequired
Name of the environment variable. Must be a C_IDENTIFIER, and may not exceed 32768 characters.
- valuestring | null
Literal value of the environment variable. Defaults to "" and the maximum allowed length is 32768 characters. Variable references are not supported in Cloud Run.
- namestringrequired
- volume_mountsobject[] | null
Volume to mount into the container's filesystem.
Each item
- mount_pathstringrequired
Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be /cloudsql. All instances defined in the Volume will be available as /cloudsql/[instance]. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run
- namestringrequired
This must match the Name of a Volume.
- sub_pathstring | null
Path within the volume from which the container's volume should be mounted.
- mount_pathstringrequired
- argsstring[] | null
- templatesobject[] | null
- scalingobject | null
Scaling settings for this Revision.
Fields
- concurrency_utilizationnumber | null
Determines a threshold for concurrency utilization before scaling begins. Accepted values are between 0.1 and 0.95 (inclusive) or 0.0 to disable concurrency utilization as threshold for scaling. CPU and concurrency scaling cannot both be disabled.
- cpu_utilizationnumber | null
Determines a threshold for CPU utilization before scaling begins. Accepted values are between 0.1 and 0.95 (inclusive) or 0.0 to disable CPU utilization as threshold for scaling. CPU and concurrency scaling cannot both be disabled.
- max_instance_countnumber | null
Maximum number of serving instances that this resource should have. Must not be less than minimum instance count. If absent, Cloud Run will calculate a default value based on the project's available container instances quota in the region and specified instance size.
- min_instance_countnumber | null
Minimum number of serving instances that this resource should have. Defaults to 0. Must not be greater than maximum instance count.
- concurrency_utilizationnumber | null
- volumesobject[] | null
A list of Volumes to make available to containers.
Each item
- namestringrequired
Volume's name.
- cloud_sql_instanceobject | null
For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
Fields
- instancesstring[] | null
The Cloud SQL instance connection names, as can be found in https://console.cloud.google.com/sql/instances. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. Format: {project}:{location}:{instance}
- instancesstring[] | null
- empty_dirobject | null
Ephemeral storage used as a shared volume.
Fields
- mediumstring | null
The different types of medium supported for EmptyDir. Default value: "MEMORY" Possible values: ["MEMORY", "DISK"]
- size_limitstring | null
Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. This field's values are of the 'Quantity' k8s type: https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/quantity/. The default is nil which means that the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir.
- mediumstring | null
- gcsobject | null
Cloud Storage bucket mounted as a volume using GCSFuse. This feature is only supported in the gen2 execution environment.
Fields
- bucketstringrequired
GCS Bucket name
- mount_optionsstring[] | null
A list of flags to pass to the gcsfuse command for configuring this volume. Flags should be passed without leading dashes.
- read_onlyboolean | null
If true, mount the GCS bucket as read-only
- bucketstringrequired
- nfsobject | null
Represents an NFS mount.
Fields
- pathstringrequired
Path that is exported by the NFS server.
- read_onlyboolean | null
If true, mount the NFS volume as read only
- serverstringrequired
Hostname or IP address of the NFS server
- pathstringrequired
- secretobject | null
Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
Fields
- default_modenumber | null
Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting.
- secretstringrequired
The name of the secret in Cloud Secret Manager. Format: {secret} if the secret is in the same project. projects/{project}/secrets/{secret} if the secret is in a different project.
- itemsobject[] | null
If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version.
Each item
- modenumber | null
Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used.
- pathstringrequired
The relative path of the secret in the container.
- versionstring | null
The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version
- modenumber | null
- default_modenumber | null
- namestringrequired
- vpc_accessobject | null
VPC Access configuration to use for this Task. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.
Fields
- connectorstring | null
VPC Access connector name. Format: projects/{project}/locations/{location}/connectors/{connector}, where {project} can be project id or number.
- egressstring | null
Traffic VPC egress settings. Possible values: ["ALL_TRAFFIC", "PRIVATE_RANGES_ONLY"]
- network_interfacesobject[] | null
Direct VPC egress settings. Currently only single network interface is supported.
Each item
- networkstring | null
The VPC network that the Cloud Run resource will be able to send traffic to. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If network is not specified, it will be looked up from the subnetwork.
- subnetworkstring | null
The VPC subnetwork that the Cloud Run resource will get IPs from. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used.
- tagsstring[] | null
Network tags applied to this Cloud Run service.
- networkstring | null
- connectorstring | null
- workload_identity_configobject | null
The Revision's workload identity settings. Used to assign an [Agent Platform](https://cloud.google.com/run/docs/ai/agent-platform-features) identity to the workload.
Fields
- identitystring | null
The Revision's SPIFFE workload identity. Enables provisioning of SPIFFE workload certificates.
- identity_certificate_enabledboolean | null
Controls whether an instance receives a managed workload identity (MWLID) certificate. Defaults to true when 'identity_type' is 'IDENTITY_TYPE_AGENT_IDENTITY'.
- identity_typestring | null
The type of identity to use. 'IDENTITY_TYPE_AGENT_IDENTITY' assigns a system-managed agent identity and is required when the Service's 'functional_type' is 'FUNCTIONAL_TYPE_AGENT'. Once set, this field cannot be changed or unset. Possible values: ["IDENTITY_TYPE_SERVICE_ACCOUNT", "IDENTITY_TYPE_WORKLOAD_IDENTITY", "IDENTITY_TYPE_AGENT_IDENTITY"]
- identitystring | null
- annotationsrecord of string | null
- timeoutsobject | null
Fields
- createstring | null
- deletestring | null
- updatestring | null
- trafficobject[] | null
Specifies how to distribute traffic over a collection of Revisions belonging to the Service. If traffic is empty or not provided, defaults to 100% traffic to the latest Ready Revision.
Each item
- percentnumber | null
Specifies percent of the traffic to this Revision. This defaults to zero if unspecified.
- revisionstring | null
Revision to which to send this portion of traffic, if traffic allocation is by revision.
- tagstring | null
Indicates a string to be part of the URI to exclusively reference this target.
- typestring | null
The allocation type for this traffic target. Possible values: ["TRAFFIC_TARGET_ALLOCATION_TYPE_LATEST", "TRAFFIC_TARGET_ALLOCATION_TYPE_REVISION"]
- percentnumber | null
- annotationsrecord of string | null
- handlestring
The driver's data for the object, opaque: pass it back unchanged
update
Change a cloud run service to match its declaration, replacing it where a field cannot change in place
Input
- idstringrequired
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
- desiredrecord of anyrequired
The declared fields; a write-only one may hold a secret marker
- expectobject
Fields
- action"none" | "create" | "update" | "replace" | "delete"required
- replacestring[]required
Output
- idstringrequired
at least 1 character
- stateobjectrequired
Fields
- annotationsrecord of string | null
Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with 'run.googleapis.com', 'cloud.googleapis.com', 'serving.knative.dev', or 'autoscaling.knative.dev' namespaces, and they will be rejected in new resources. All system annotations in v1 now have a corresponding field in v2 Service. This field follows Kubernetes annotations' namespacing, limits, and rules. **Note**: This field is non-authoritative, and will only manage the annotations present in your configuration. Please refer to the field 'effective_annotations' for all of the annotations present on the resource.
- clientstring | null
Arbitrary identifier for the API client.
- client_versionstring | null
Arbitrary version identifier for the API client.
- conditionsobject[] | null
The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the Service does not reach its Serving state. See comments in reconciling for additional information on reconciliation process in Cloud Run.
Each item
- execution_reasonstring | null
- last_transition_timestring | null
- messagestring | null
- reasonstring | null
- revision_reasonstring | null
- severitystring | null
- statestring | null
- typestring | null
- create_timestring | null
The creation time.
- creatorstring | null
Email address of the authenticated creator.
- custom_audiencesstring[] | null
One or more custom audiences that you want this service to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences.
- default_uri_disabledboolean | null
Disables public resolution of the default URI of this service.
- delete_timestring | null
The deletion time.
- deletion_policystring | null
Whether Terraform will be prevented from destroying the instance. Defaults to "DELETE". When a 'terraform destroy' or 'terraform apply' would delete the instance, 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.
- deletion_protectionboolean | null
Whether Terraform will be prevented from destroying the service. Defaults to true. When a'terraform destroy' or 'terraform apply' would delete the service, the command will fail if this field is not set to false in Terraform state. When the field is set to true or unset in Terraform state, a 'terraform apply' or 'terraform destroy' that would delete the service will fail. When the field is set to false, deleting the service is allowed.
- descriptionstring | null
User-provided description of the Service. This field currently has a 512-character limit.
- effective_annotationsrecord of string | null
All of annotations (key/value pairs) present on the resource in GCP, including the annotations configured through Terraform, other clients and services.
- effective_labelsrecord of string | null
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Terraform, other clients and services.
- etagstring | null
A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
- expire_timestring | null
For a deleted resource, the time after which it will be permanently deleted.
- generationstring | null
A number that monotonically increases every time the user modifies the desired state. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a string instead of an integer.
- iap_enabledboolean | null
Used to enable/disable IAP for the cloud-run service.
- idstring | null
- ingressstring | null
Provides the ingress settings for this Service. On output, returns the currently observed ingress settings, or INGRESS_TRAFFIC_UNSPECIFIED if no revision is active. Possible values: ["INGRESS_TRAFFIC_ALL", "INGRESS_TRAFFIC_INTERNAL_ONLY", "INGRESS_TRAFFIC_INTERNAL_LOAD_BALANCER"]
- invoker_iam_disabledboolean | null
Disables IAM permission check for run.routes.invoke for callers of this service. For more information, visit https://cloud.google.com/run/docs/securing/managing-access#invoker_check.
- labelsrecord of string | null
Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://docs.cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with 'run.googleapis.com', 'cloud.googleapis.com', 'serving.knative.dev', or 'autoscaling.knative.dev' namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 Service. **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.
- last_modifierstring | null
Email address of the last authenticated modifier.
- latest_created_revisionstring | null
Name of the last created revision. See comments in reconciling for additional information on reconciliation process in Cloud Run.
- latest_ready_revisionstring | null
Name of the latest revision that is serving traffic. See comments in reconciling for additional information on reconciliation process in Cloud Run.
- launch_stagestring | null
The launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/products#product-launch-stages). Cloud Run supports ALPHA, BETA, and GA. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output. Possible values: ["UNIMPLEMENTED", "PRELAUNCH", "EARLY_ACCESS", "ALPHA", "BETA", "GA", "DEPRECATED"]
- locationstringrequired
The location of the cloud run service
- namestringrequired
Name of the Service.
- observed_generationstring | null
The generation of this Service currently serving traffic. See comments in reconciling for additional information on reconciliation process in Cloud Run. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a string instead of an integer.
- projectstring | null
- reconcilingboolean | null
Returns true if the Service is currently being acted upon by the system to bring it into the desired state. When a new Service is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the Service to the desired serving state. This process is called reconciliation. While reconciliation is in process, observedGeneration, latest_ready_revison, trafficStatuses, and uri will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the Service, or there was an error, and reconciliation failed. This state can be found in terminalCondition.state. If reconciliation succeeded, the following fields will match: traffic and trafficStatuses, observedGeneration and generation, latestReadyRevision and latestCreatedRevision. If reconciliation failed, trafficStatuses, observedGeneration, and latestReadyRevision will have the state of the last serving revision, or empty for newly created Services. Additional information on the failure can be found in terminalCondition and conditions.
- ssh_enabledboolean | null
Enables SSH access to the Service.
- tagsrecord of string | null
A map of resource manager tags. Resource manager tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/{tag_value_id}.
- terminal_conditionobject[] | null
The Condition of this Service, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in reconciling for additional information on reconciliation process in Cloud Run.
Each item
- execution_reasonstring | null
- last_transition_timestring | null
- messagestring | null
- reasonstring | null
- revision_reasonstring | null
- severitystring | null
- statestring | null
- typestring | null
- terraform_labelsrecord of string | null
The combination of labels configured directly on the resource and default labels configured on the provider.
- traffic_statusesobject[] | null
Detailed status information for corresponding traffic targets. See comments in reconciling for additional information on reconciliation process in Cloud Run.
Each item
- percentnumber | null
- revisionstring | null
- tagstring | null
- typestring | null
- uristring | null
- uidstring | null
Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
- update_timestring | null
The last-modified time.
- uristring | null
The main URI in which this Service is serving traffic.
- urlsstring[] | null
All URLs serving traffic for this Service.
- binary_authorizationobject | null
Settings for the Binary Authorization feature.
Fields
- breakglass_justificationstring | null
If present, indicates to use Breakglass using this justification. If useDefault is False, then it must be empty. For more information on breakglass, see https://cloud.google.com/binary-authorization/docs/using-breakglass
- policystring | null
The path to a binary authorization policy. Format: projects/{project}/platforms/cloudRun/{policy-name}
- use_defaultboolean | null
If True, indicates to use the default project's binary authorization policy. If False, binary authorization will be disabled.
- breakglass_justificationstring | null
- build_configobject | null
Configuration for building a Cloud Run function.
Fields
- base_imagestring | null
The base image used to build the function.
- enable_automatic_updatesboolean | null
Sets whether the function will receive automatic base image updates.
- environment_variablesrecord of string | null
User-provided build-time environment variables for the function.
- function_targetstring | null
The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix, if not specified. For backward compatibility, if function with given name is not found, then the system will try to use function named "function".
- image_uristring | null
Artifact Registry URI to store the built image.
- namestring | null
The Cloud Build name of the latest successful deployment of the function.
- service_accountstring | null
Service account to be used for building the container. The format of this field is 'projects/{projectId}/serviceAccounts/{serviceAccountEmail}'.
- source_locationstring | null
The Cloud Storage bucket URI where the function source code is located.
- worker_poolstring | null
Name of the Cloud Build Custom Worker Pool that should be used to build the Cloud Run 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.
- base_imagestring | null
- multi_region_settingsobject | null
Settings for creating a Multi-Region Service. Make sure to use region = 'global' when using them. For more information, visit https://cloud.google.com/run/docs/multiple-regions#deploy
Fields
- multi_region_idstring | null
System-generated unique id for the multi-region Service.
- regionsstring[] | null
The list of regions to deploy the multi-region Service.
- multi_region_idstring | null
- scalingobject | null
Scaling settings that apply to the whole service
Fields
- manual_instance_countnumber | null
Total instance count for the service in manual scaling mode. This number of instances is divided among all revisions with specified traffic based on the percent of traffic they are receiving.
- max_instance_countnumber | null
Combined maximum number of instances for all revisions receiving traffic.
- min_instance_countnumber | null
Minimum number of instances for the service, to be divided among all revisions receiving traffic.
- scaling_modestring | null
The [scaling mode](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#scalingmode) for the service. Possible values: ["AUTOMATIC", "MANUAL"]
- manual_instance_countnumber | null
- templateobjectrequired
The template used to create revisions for this Service.
Fields
- annotationsrecord of string | null
Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with 'run.googleapis.com', 'cloud.googleapis.com', 'serving.knative.dev', or 'autoscaling.knative.dev' namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 RevisionTemplate. This field follows Kubernetes annotations' namespacing, limits, and rules.
- encryption_keystring | null
A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek
- execution_environmentstring | null
The sandbox environment to host this Revision. Possible values: ["EXECUTION_ENVIRONMENT_GEN1", "EXECUTION_ENVIRONMENT_GEN2"]
- gpu_zonal_redundancy_disabledboolean | null
True if GPU zonal redundancy is disabled on this revision.
- health_check_disabledboolean | null
Disables health checking containers during deployment.
- labelsrecord of string | null
Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://docs.cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with 'run.googleapis.com', 'cloud.googleapis.com', 'serving.knative.dev', or 'autoscaling.knative.dev' namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 RevisionTemplate.
- max_instance_request_concurrencynumber | null
Sets the maximum number of requests that each serving instance can receive. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.
- revisionstring | null
The unique name for the revision. If this field is omitted, it will be automatically generated based on the Service name.
- service_accountstring | null
Email address of the IAM service account associated with the revision of the service. The service account represents the identity of the running revision, and determines what permissions the revision has. If not provided, the revision will use the project's default service account.
- session_affinityboolean | null
Enables session affinity. For more information, go to https://cloud.google.com/run/docs/configuring/session-affinity
- timeoutstring | null
Max allowed time for an instance to respond to a request. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
- containersobject[] | null
Holds the containers that define the unit of execution for this Service.
Each item
- argsstring[] | null
Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run.
- base_image_uristring | null
Base image for this container. If set, it indicates that the service is enrolled into automatic base image update.
- build_infoobject[] | null
The build info of the container image.
Each item
- function_targetstring | null
- source_locationstring | null
- commandstring[] | null
Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
- depends_onstring[] | null
Containers which should be started before this container. If specified the container will wait to start until all containers with the listed names are healthy.
- imagestringrequired
URL of the Container image in Google Container Registry or Google Artifact Registry. More info: https://kubernetes.io/docs/concepts/containers/images
- namestring | null
Name of the container specified as a DNS_LABEL.
- sandbox_launcherboolean | null
Indicates that this container can act as a sandbox supervisor and launch sandboxes.
- working_dirstring | null
Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image.
- envobject[] | null
List of environment variables to set in the container.
Each item
- namestringrequired
Name of the environment variable. Must be a C_IDENTIFIER, and may not exceed 32768 characters.
- valuestring | null
Literal value of the environment variable. Defaults to "" and the maximum allowed length is 32768 characters. Variable references are not supported in Cloud Run.
- value_sourceobject | null
Source for the environment variable's value.
Fields
- secret_key_refobject | null
Selects a secret and a specific version from Cloud Secret Manager.
Fields
- secretstringrequired
The name of the secret in Cloud Secret Manager. Format: {secretName} if the secret is in the same project. projects/{project}/secrets/{secretName} if the secret is in a different project.
- versionstring | null
The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version.
- secretstringrequired
- secret_key_refobject | null
- namestringrequired
- liveness_probeobject | null
Periodic probe of container liveness. Container will be restarted if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Fields
- failure_thresholdnumber | null
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
- initial_delay_secondsnumber | null
Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- period_secondsnumber | null
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeoutSeconds
- timeout_secondsnumber | null
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than periodSeconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- grpcobject | null
GRPC specifies an action involving a GRPC port.
Fields
- portnumber | null
Port number to access on the container. Number must be in the range 1 to 65535. If not specified, defaults to the same value as container.ports[0].containerPort.
- servicestring | null
The name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.
- portnumber | null
- http_getobject | null
HTTPGet specifies the http request to perform.
Fields
- pathstring | null
Path to access on the HTTP server. Defaults to '/'.
- portnumber | null
Port number to access on the container. Number must be in the range 1 to 65535. If not specified, defaults to the same value as container.ports[0].containerPort.
- http_headersobject[] | null
Custom headers to set in the request. HTTP allows repeated headers.
Each item
- namestringrequired
The header field name
- valuestring | null
The header field value
- namestringrequired
- pathstring | null
- tcp_socketobject | null
TCPSocketAction describes an action based on opening a socket
Fields
- portnumberrequired
Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
- portnumberrequired
- failure_thresholdnumber | null
- portsobject | null
List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on
Fields
- container_portnumber | null
Port number the container listens on. This must be a valid TCP port number, 0 < containerPort < 65536.
- namestring | null
If specified, used to specify which protocol to use. Allowed values are "http1" and "h2c".
- container_portnumber | null
- readiness_probeobject | null
Periodic probe of container readiness.
Fields
- failure_thresholdnumber | null
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3.
- period_secondsnumber | null
How often (in seconds) to perform the probe. Default to 10 seconds.
- success_thresholdnumber | null
Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 2.
- timeout_secondsnumber | null
Number of seconds after which the probe times out. Defaults to 1 second. Must be smaller than period_seconds.
- grpcobject | null
GRPC specifies an action involving a GRPC port.
Fields
- portnumber | null
Port number to access on the container. Number must be in the range 1 to 65535. If not specified, defaults to the same value as container.ports[0].containerPort.
- servicestring | null
The name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.
- portnumber | null
- http_getobject | null
HttpGet specifies the http request to perform.
Fields
- pathstring | null
Path to access on the HTTP server. If set, it should not be empty string.
- portnumber | null
Port number to access on the container. Number must be in the range 1 to 65535. If not specified, defaults to the same value as container.ports[0].containerPort.
- pathstring | null
- failure_thresholdnumber | null
- resourcesobject | null
Compute Resource requirements by this container. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
Fields
- cpu_idleboolean | null
Determines whether CPU is only allocated during requests. True by default if the parent 'resources' field is not set. However, if 'resources' is set, this field must be explicitly set to true to preserve the default behavior.
- limitsrecord of string | null
Only memory, CPU, and nvidia.com/gpu are supported. Use key 'cpu' for CPU limit, 'memory' for memory limit, 'nvidia.com/gpu' for gpu limit. Note: The only supported values for CPU are '1', '2', '4', '6' and '8'. Setting 4 CPU requires at least 2Gi of memory, setting 6 or more CPU requires at least 4Gi of memory. The values of the map is string form of the 'quantity' k8s type: https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go
- startup_cpu_boostboolean | null
Determines whether CPU should be boosted on startup of a new container instance above the requested CPU threshold, this can help reduce cold-start latency.
- cpu_idleboolean | null
- startup_probeobject | null
Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
Fields
- failure_thresholdnumber | null
Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
- initial_delay_secondsnumber | null
Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- period_secondsnumber | null
How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeoutSeconds
- timeout_secondsnumber | null
Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than periodSeconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
- grpcobject | null
GRPC specifies an action involving a GRPC port.
Fields
- portnumber | null
Port number to access on the container. Number must be in the range 1 to 65535. If not specified, defaults to the same value as container.ports[0].containerPort.
- servicestring | null
The name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.
- portnumber | null
- http_getobject | null
HTTPGet specifies the http request to perform. Exactly one of HTTPGet or TCPSocket must be specified.
Fields
- pathstring | null
Path to access on the HTTP server. Defaults to '/'.
- portnumber | null
Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the same value as container.ports[0].containerPort.
- http_headersobject[] | null
Custom headers to set in the request. HTTP allows repeated headers.
Each item
- namestringrequired
The header field name
- valuestring | null
The header field value
- namestringrequired
- pathstring | null
- tcp_socketobject | null
TCPSocket specifies an action involving a TCP port. Exactly one of HTTPGet or TCPSocket must be specified.
Fields
- portnumber | null
Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the same value as container.ports[0].containerPort.
- portnumber | null
- failure_thresholdnumber | null
- volume_mountsobject[] | null
Volume to mount into the container's filesystem.
Each item
- mount_pathstringrequired
Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be /cloudsql. All instances defined in the Volume will be available as /cloudsql/[instance]. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run
- namestringrequired
This must match the Name of a Volume.
- sub_pathstring | null
Path within the volume from which the container's volume should be mounted.
- mount_pathstringrequired
- argsstring[] | null
- node_selectorobject | null
Node Selector describes the hardware requirements of the resources.
Fields
- acceleratorstringrequired
The GPU to attach to an instance. See https://cloud.google.com/run/docs/configuring/services/gpu for configuring GPU.
- acceleratorstringrequired
- sandboxesobject | null
Configuration for sandboxes.
Fields
- templatesobject[] | null
Sandbox templates that can be launched through the 'sandbox' CLI.
Each item
- argsstring[] | null
Arguments to the entrypoint. The docker image's CMD is used if this is not provided.
- commandstring[] | null
Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided.
- imagestringrequired
Name of the container image in Dockerhub or Artifact Registry. If the host is not provided, Dockerhub is assumed.
- namestringrequired
Name of the sandbox specified as a DNS_LABEL (RFC 1123).
- working_dirstring | null
Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image.
- envobject[] | null
List of environment variables to set in the sandbox.
Each item
- namestringrequired
Name of the environment variable. Must be a C_IDENTIFIER, and may not exceed 32768 characters.
- valuestring | null
Literal value of the environment variable. Defaults to "" and the maximum allowed length is 32768 characters. Variable references are not supported in Cloud Run.
- namestringrequired
- volume_mountsobject[] | null
Volume to mount into the container's filesystem.
Each item
- mount_pathstringrequired
Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be /cloudsql. All instances defined in the Volume will be available as /cloudsql/[instance]. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run
- namestringrequired
This must match the Name of a Volume.
- sub_pathstring | null
Path within the volume from which the container's volume should be mounted.
- mount_pathstringrequired
- argsstring[] | null
- templatesobject[] | null
- scalingobject | null
Scaling settings for this Revision.
Fields
- concurrency_utilizationnumber | null
Determines a threshold for concurrency utilization before scaling begins. Accepted values are between 0.1 and 0.95 (inclusive) or 0.0 to disable concurrency utilization as threshold for scaling. CPU and concurrency scaling cannot both be disabled.
- cpu_utilizationnumber | null
Determines a threshold for CPU utilization before scaling begins. Accepted values are between 0.1 and 0.95 (inclusive) or 0.0 to disable CPU utilization as threshold for scaling. CPU and concurrency scaling cannot both be disabled.
- max_instance_countnumber | null
Maximum number of serving instances that this resource should have. Must not be less than minimum instance count. If absent, Cloud Run will calculate a default value based on the project's available container instances quota in the region and specified instance size.
- min_instance_countnumber | null
Minimum number of serving instances that this resource should have. Defaults to 0. Must not be greater than maximum instance count.
- concurrency_utilizationnumber | null
- volumesobject[] | null
A list of Volumes to make available to containers.
Each item
- namestringrequired
Volume's name.
- cloud_sql_instanceobject | null
For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
Fields
- instancesstring[] | null
The Cloud SQL instance connection names, as can be found in https://console.cloud.google.com/sql/instances. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. Format: {project}:{location}:{instance}
- instancesstring[] | null
- empty_dirobject | null
Ephemeral storage used as a shared volume.
Fields
- mediumstring | null
The different types of medium supported for EmptyDir. Default value: "MEMORY" Possible values: ["MEMORY", "DISK"]
- size_limitstring | null
Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. This field's values are of the 'Quantity' k8s type: https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/quantity/. The default is nil which means that the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir.
- mediumstring | null
- gcsobject | null
Cloud Storage bucket mounted as a volume using GCSFuse. This feature is only supported in the gen2 execution environment.
Fields
- bucketstringrequired
GCS Bucket name
- mount_optionsstring[] | null
A list of flags to pass to the gcsfuse command for configuring this volume. Flags should be passed without leading dashes.
- read_onlyboolean | null
If true, mount the GCS bucket as read-only
- bucketstringrequired
- nfsobject | null
Represents an NFS mount.
Fields
- pathstringrequired
Path that is exported by the NFS server.
- read_onlyboolean | null
If true, mount the NFS volume as read only
- serverstringrequired
Hostname or IP address of the NFS server
- pathstringrequired
- secretobject | null
Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
Fields
- default_modenumber | null
Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting.
- secretstringrequired
The name of the secret in Cloud Secret Manager. Format: {secret} if the secret is in the same project. projects/{project}/secrets/{secret} if the secret is in a different project.
- itemsobject[] | null
If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version.
Each item
- modenumber | null
Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used.
- pathstringrequired
The relative path of the secret in the container.
- versionstring | null
The Cloud Secret Manager secret version. Can be 'latest' for the latest value or an integer for a specific version
- modenumber | null
- default_modenumber | null
- namestringrequired
- vpc_accessobject | null
VPC Access configuration to use for this Task. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.
Fields
- connectorstring | null
VPC Access connector name. Format: projects/{project}/locations/{location}/connectors/{connector}, where {project} can be project id or number.
- egressstring | null
Traffic VPC egress settings. Possible values: ["ALL_TRAFFIC", "PRIVATE_RANGES_ONLY"]
- network_interfacesobject[] | null
Direct VPC egress settings. Currently only single network interface is supported.
Each item
- networkstring | null
The VPC network that the Cloud Run resource will be able to send traffic to. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If network is not specified, it will be looked up from the subnetwork.
- subnetworkstring | null
The VPC subnetwork that the Cloud Run resource will get IPs from. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used.
- tagsstring[] | null
Network tags applied to this Cloud Run service.
- networkstring | null
- connectorstring | null
- workload_identity_configobject | null
The Revision's workload identity settings. Used to assign an [Agent Platform](https://cloud.google.com/run/docs/ai/agent-platform-features) identity to the workload.
Fields
- identitystring | null
The Revision's SPIFFE workload identity. Enables provisioning of SPIFFE workload certificates.
- identity_certificate_enabledboolean | null
Controls whether an instance receives a managed workload identity (MWLID) certificate. Defaults to true when 'identity_type' is 'IDENTITY_TYPE_AGENT_IDENTITY'.
- identity_typestring | null
The type of identity to use. 'IDENTITY_TYPE_AGENT_IDENTITY' assigns a system-managed agent identity and is required when the Service's 'functional_type' is 'FUNCTIONAL_TYPE_AGENT'. Once set, this field cannot be changed or unset. Possible values: ["IDENTITY_TYPE_SERVICE_ACCOUNT", "IDENTITY_TYPE_WORKLOAD_IDENTITY", "IDENTITY_TYPE_AGENT_IDENTITY"]
- identitystring | null
- annotationsrecord of string | null
- timeoutsobject | null
Fields
- createstring | null
- deletestring | null
- updatestring | null
- trafficobject[] | null
Specifies how to distribute traffic over a collection of Revisions belonging to the Service. If traffic is empty or not provided, defaults to 100% traffic to the latest Ready Revision.
Each item
- percentnumber | null
Specifies percent of the traffic to this Revision. This defaults to zero if unspecified.
- revisionstring | null
Revision to which to send this portion of traffic, if traffic allocation is by revision.
- tagstring | null
Indicates a string to be part of the URI to exclusively reference this target.
- typestring | null
The allocation type for this traffic target. Possible values: ["TRAFFIC_TARGET_ALLOCATION_TYPE_LATEST", "TRAFFIC_TARGET_ALLOCATION_TYPE_REVISION"]
- percentnumber | null
- annotationsrecord of string | null
- handlestring
The driver's data for the object, opaque: pass it back unchanged
delete
Delete a cloud run service; done already when it is gone
Input
- idstringrequired
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
Output
- idstringrequired
at least 1 character
- gonetruerequired
cloudRunServiceIamMember
import
Find a cloud run service access by its name role member [condition title] or its binding id and read it; gone when there is none
Input
- idstringrequired
at least 1 character
Output
- idstringrequired
at least 1 character
- gonebooleanrequired
- stateobject
Fields
- etagstring | null
- idstring | null
- locationstring | null
- memberstringrequired
- namestringrequired
- projectstring | null
- rolestringrequired
- conditionobject | null
Fields
- descriptionstring | null
- expressionstringrequired
- titlestringrequired
- handlestring
The driver's data for the object, opaque: pass it back unchanged
read
Read a cloud run service access as it is now; gone when it no longer exists
Input
- idstringrequired
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
Output
- idstringrequired
at least 1 character
- gonebooleanrequired
- stateobject
Fields
- etagstring | null
- idstring | null
- locationstring | null
- memberstringrequired
- namestringrequired
- projectstring | null
- rolestringrequired
- conditionobject | null
Fields
- descriptionstring | null
- expressionstringrequired
- titlestringrequired
- handlestring
The driver's data for the object, opaque: pass it back unchanged
plan
Plan how apply would make a cloud run service access match its declaration (or delete it, given none); nothing changes
Input
- idstring
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
- desiredrecord of any
The declared fields; a write-only one may hold a secret marker
Output
- action"none" | "create" | "update" | "replace" | "delete"required
- plannedrecord of any
- unknownstring[]required
- replacestring[]required
The fields whose change replaces the object: not empty exactly when
replace
create
Create a cloud run service access as declared
Input
- desiredrecord of anyrequired
The declared fields; a write-only one may hold a secret marker
Output
- idstringrequired
at least 1 character
- stateobjectrequired
Fields
- etagstring | null
- idstring | null
- locationstring | null
- memberstringrequired
- namestringrequired
- projectstring | null
- rolestringrequired
- conditionobject | null
Fields
- descriptionstring | null
- expressionstringrequired
- titlestringrequired
- handlestring
The driver's data for the object, opaque: pass it back unchanged
update
Change a cloud run service access to match its declaration, replacing it where a field cannot change in place
Input
- idstringrequired
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
- desiredrecord of anyrequired
The declared fields; a write-only one may hold a secret marker
- expectobject
Fields
- action"none" | "create" | "update" | "replace" | "delete"required
- replacestring[]required
Output
- idstringrequired
at least 1 character
- stateobjectrequired
Fields
- etagstring | null
- idstring | null
- locationstring | null
- memberstringrequired
- namestringrequired
- projectstring | null
- rolestringrequired
- conditionobject | null
Fields
- descriptionstring | null
- expressionstringrequired
- titlestringrequired
- handlestring
The driver's data for the object, opaque: pass it back unchanged
delete
Delete a cloud run service access; done already when it is gone
Input
- idstringrequired
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
Output
- idstringrequired
at least 1 character
- gonetruerequired
These pages describe sanoma 0.11.24.