cloudkms library

Classes

AuditConfig
Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": "user:aliya@example.com" } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
AuditConfigResponse
Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": "user:aliya@example.com" } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
AuditLogConfig
Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
AuditLogConfigResponse
Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
Binding
Associates members, or principals, with a role.
BindingResponse
Associates members, or principals, with a role.
Certificate
A Certificate represents an X.509 certificate used to authenticate HTTPS connections to EKM replicas.
CertificateChainsResponse
Certificate chains needed to verify the attestation. Certificates in chains are PEM-encoded and are ordered based on https://tools.ietf.org/html/rfc5246#section-7.4.2.
CertificateResponse
A Certificate represents an X.509 certificate used to authenticate HTTPS connections to EKM replicas.
CryptoKey
Create a new CryptoKey within a KeyRing. CryptoKey.purpose and CryptoKey.version_template.algorithm are required. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
CryptoKeyArgs
The set of arguments for CryptoKey. The set of arguments for CryptoKey.
CryptoKeyVersion
Create a new CryptoKeyVersion in a CryptoKey. The server will assign the next sequential id. If unset, state will be set to ENABLED. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
CryptoKeyVersionArgs
The set of arguments for CryptoKeyVersion. The set of arguments for CryptoKeyVersion.
CryptoKeyVersionResponse
A CryptoKeyVersion represents an individual cryptographic key, and the associated key material. An ENABLED version can be used for cryptographic operations. For security reasons, the raw cryptographic key material represented by a CryptoKeyVersion can never be viewed or exported. It can only be used to encrypt, decrypt, or sign data when an authorized user or application invokes Cloud KMS.
CryptoKeyVersionTemplate
A CryptoKeyVersionTemplate specifies the properties to use when creating a new CryptoKeyVersion, either manually with CreateCryptoKeyVersion or automatically as a result of auto-rotation.
CryptoKeyVersionTemplateResponse
A CryptoKeyVersionTemplate specifies the properties to use when creating a new CryptoKeyVersion, either manually with CreateCryptoKeyVersion or automatically as a result of auto-rotation.
EkmConfigIamBinding
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
EkmConfigIamBindingArgs
The set of arguments for EkmConfigIamBinding. The set of arguments for EkmConfigIamBinding.
EkmConfigIamMember
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
EkmConfigIamMemberArgs
The set of arguments for EkmConfigIamMember. The set of arguments for EkmConfigIamMember.
EkmConfigIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
EkmConfigIamPolicyArgs
The set of arguments for EkmConfigIamPolicy. The set of arguments for EkmConfigIamPolicy.
EkmConnection
Creates a new EkmConnection in a given Project and Location. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
EkmConnectionArgs
The set of arguments for EkmConnection. The set of arguments for EkmConnection.
EkmConnectionIamBinding
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
EkmConnectionIamBindingArgs
The set of arguments for EkmConnectionIamBinding. The set of arguments for EkmConnectionIamBinding.
EkmConnectionIamMember
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
EkmConnectionIamMemberArgs
The set of arguments for EkmConnectionIamMember. The set of arguments for EkmConnectionIamMember.
EkmConnectionIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
EkmConnectionIamPolicyArgs
The set of arguments for EkmConnectionIamPolicy. The set of arguments for EkmConnectionIamPolicy.
Expr
Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
ExprResponse
Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
ExternalProtectionLevelOptions
ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
ExternalProtectionLevelOptionsResponse
ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
GetCryptoKeyArgs
Arguments for getCryptoKey. Arguments for getCryptoKey.
GetCryptoKeyResult
Result data returned by getCryptoKey.
GetCryptoKeyVersionArgs
Arguments for getCryptoKeyVersion. Arguments for getCryptoKeyVersion.
GetCryptoKeyVersionResult
Result data returned by getCryptoKeyVersion.
GetEkmConfigIamPolicyArgs
Arguments for getEkmConfigIamPolicy. Arguments for getEkmConfigIamPolicy.
GetEkmConfigIamPolicyResult
Result data returned by getEkmConfigIamPolicy.
GetEkmConnectionArgs
Arguments for getEkmConnection. Arguments for getEkmConnection.
GetEkmConnectionIamPolicyArgs
Arguments for getEkmConnectionIamPolicy. Arguments for getEkmConnectionIamPolicy.
GetEkmConnectionIamPolicyResult
Result data returned by getEkmConnectionIamPolicy.
GetEkmConnectionResult
Result data returned by getEkmConnection.
GetImportJobArgs
Arguments for getImportJob. Arguments for getImportJob.
GetImportJobResult
Result data returned by getImportJob.
GetKeyRingArgs
Arguments for getKeyRing. Arguments for getKeyRing.
GetKeyRingCryptoKeyIamPolicyArgs
Arguments for getKeyRingCryptoKeyIamPolicy. Arguments for getKeyRingCryptoKeyIamPolicy.
GetKeyRingCryptoKeyIamPolicyResult
Result data returned by getKeyRingCryptoKeyIamPolicy.
GetKeyRingIamPolicyArgs
Arguments for getKeyRingIamPolicy. Arguments for getKeyRingIamPolicy.
GetKeyRingIamPolicyResult
Result data returned by getKeyRingIamPolicy.
GetKeyRingImportJobIamPolicyArgs
Arguments for getKeyRingImportJobIamPolicy. Arguments for getKeyRingImportJobIamPolicy.
GetKeyRingImportJobIamPolicyResult
Result data returned by getKeyRingImportJobIamPolicy.
GetKeyRingResult
Result data returned by getKeyRing.
ImportJob
Create a new ImportJob within a KeyRing. ImportJob.import_method is required. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
ImportJobArgs
The set of arguments for ImportJob. The set of arguments for ImportJob.
KeyOperationAttestationResponse
Contains an HSM-generated attestation about a key operation. For more information, see Verifying attestations (https://cloud.google.com/kms/docs/attest-key).
KeyRing
Create a new KeyRing in a given Project and Location. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
KeyRingArgs
The set of arguments for KeyRing. The set of arguments for KeyRing.
KeyRingCryptoKeyIamBinding
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
KeyRingCryptoKeyIamBindingArgs
The set of arguments for KeyRingCryptoKeyIamBinding. The set of arguments for KeyRingCryptoKeyIamBinding.
KeyRingCryptoKeyIamMember
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
KeyRingCryptoKeyIamMemberArgs
The set of arguments for KeyRingCryptoKeyIamMember. The set of arguments for KeyRingCryptoKeyIamMember.
KeyRingCryptoKeyIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
KeyRingCryptoKeyIamPolicyArgs
The set of arguments for KeyRingCryptoKeyIamPolicy. The set of arguments for KeyRingCryptoKeyIamPolicy.
KeyRingIamBinding
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
KeyRingIamBindingArgs
The set of arguments for KeyRingIamBinding. The set of arguments for KeyRingIamBinding.
KeyRingIamMember
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
KeyRingIamMemberArgs
The set of arguments for KeyRingIamMember. The set of arguments for KeyRingIamMember.
KeyRingIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
KeyRingIamPolicyArgs
The set of arguments for KeyRingIamPolicy. The set of arguments for KeyRingIamPolicy.
KeyRingImportJobIamBinding
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
KeyRingImportJobIamBindingArgs
The set of arguments for KeyRingImportJobIamBinding. The set of arguments for KeyRingImportJobIamBinding.
KeyRingImportJobIamMember
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
KeyRingImportJobIamMemberArgs
The set of arguments for KeyRingImportJobIamMember. The set of arguments for KeyRingImportJobIamMember.
KeyRingImportJobIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
KeyRingImportJobIamPolicyArgs
The set of arguments for KeyRingImportJobIamPolicy. The set of arguments for KeyRingImportJobIamPolicy.
ServiceResolver
A ServiceResolver represents an EKM replica that can be reached within an EkmConnection.
ServiceResolverResponse
A ServiceResolver represents an EKM replica that can be reached within an EkmConnection.
WrappingPublicKeyResponse
The public key component of the wrapping key. For details of the type of key this public key corresponds to, see the ImportMethod.

Enums

AuditLogConfigLogType
The log type that this config enables.
CryptoKeyPurpose
Immutable. The immutable purpose of this CryptoKey.
CryptoKeyVersionState
The current state of the CryptoKeyVersion.
CryptoKeyVersionTemplateAlgorithm
Required. Algorithm to use when creating a CryptoKeyVersion based on this template. For backwards compatibility, GOOGLE_SYMMETRIC_ENCRYPTION is implied if both this field is omitted and CryptoKey.purpose is ENCRYPT_DECRYPT.
CryptoKeyVersionTemplateProtectionLevel
ProtectionLevel to use when creating a CryptoKeyVersion based on this template. Immutable. Defaults to SOFTWARE.
EkmConnectionKeyManagementMode
Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults to MANUAL.
ImportJobImportMethod
Required. Immutable. The wrapping method to be used for incoming key material.
ImportJobProtectionLevel
Required. Immutable. The protection level of the ImportJob. This must match the protection_level of the version_template on the CryptoKey you attempt to import into.

Functions

getCryptoKey(GetCryptoKeyArgs args, {InvokeOptions? options}) → Future<GetCryptoKeyResult>
Returns metadata for a given CryptoKey, as well as its primary CryptoKeyVersion. args Arguments passed to this invoke. Arguments for getCryptoKey. options Invoke options controlling this call.
getCryptoKeyVersion(GetCryptoKeyVersionArgs args, {InvokeOptions? options}) → Future<GetCryptoKeyVersionResult>
Returns metadata for a given CryptoKeyVersion. args Arguments passed to this invoke. Arguments for getCryptoKeyVersion. options Invoke options controlling this call.
getEkmConfigIamPolicy(GetEkmConfigIamPolicyArgs args, {InvokeOptions? options}) → Future<GetEkmConfigIamPolicyResult>
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. args Arguments passed to this invoke. Arguments for getEkmConfigIamPolicy. options Invoke options controlling this call.
getEkmConnection(GetEkmConnectionArgs args, {InvokeOptions? options}) → Future<GetEkmConnectionResult>
Returns metadata for a given EkmConnection. args Arguments passed to this invoke. Arguments for getEkmConnection. options Invoke options controlling this call.
getEkmConnectionIamPolicy(GetEkmConnectionIamPolicyArgs args, {InvokeOptions? options}) → Future<GetEkmConnectionIamPolicyResult>
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. args Arguments passed to this invoke. Arguments for getEkmConnectionIamPolicy. options Invoke options controlling this call.
getImportJob(GetImportJobArgs args, {InvokeOptions? options}) → Future<GetImportJobResult>
Returns metadata for a given ImportJob. args Arguments passed to this invoke. Arguments for getImportJob. options Invoke options controlling this call.
getKeyRing(GetKeyRingArgs args, {InvokeOptions? options}) → Future<GetKeyRingResult>
Returns metadata for a given KeyRing. args Arguments passed to this invoke. Arguments for getKeyRing. options Invoke options controlling this call.
getKeyRingCryptoKeyIamPolicy(GetKeyRingCryptoKeyIamPolicyArgs args, {InvokeOptions? options}) → Future<GetKeyRingCryptoKeyIamPolicyResult>
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. args Arguments passed to this invoke. Arguments for getKeyRingCryptoKeyIamPolicy. options Invoke options controlling this call.
getKeyRingIamPolicy(GetKeyRingIamPolicyArgs args, {InvokeOptions? options}) → Future<GetKeyRingIamPolicyResult>
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. args Arguments passed to this invoke. Arguments for getKeyRingIamPolicy. options Invoke options controlling this call.
getKeyRingImportJobIamPolicy(GetKeyRingImportJobIamPolicyArgs args, {InvokeOptions? options}) → Future<GetKeyRingImportJobIamPolicyResult>
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. args Arguments passed to this invoke. Arguments for getKeyRingImportJobIamPolicy. options Invoke options controlling this call.