KeyRingImportJob class

A KeyRingImportJob can be used to create CryptoKeys and CryptoKeyVersions using pre-existing key material, generated outside of Cloud KMS. A KeyRingImportJob expires 3 days after it is created. Once expired, Cloud KMS will no longer be able to import or unwrap any key material that was wrapped with the KeyRingImportJob's public key.

> Note: KeyRingImportJobs cannot be deleted from Google Cloud Platform. Destroying a provider-managed KeyRingImportJob will remove it from state but will not delete the resource from the project.

To get more information about KeyRingImportJob, see:

Example Usage

Import

KeyRingImportJob can be imported using any of these accepted formats:

{{name}}

When using the pulumi import command, KeyRingImportJob can be imported using one of the formats above. For example:

$ pulumi import gcp:kms/keyRingImportJob:KeyRingImportJob default {{name}}

Constructors

KeyRingImportJob(String name, {KeyRingImportJobArgs? args, CustomResourceOptions? options}): Creates a new KeyRingImportJob. name The Pulumi resource name. args Arguments used to configure this KeyRingImportJob. The set of arguments for KeyRingImportJob. options Resource options controlling this resource's behavior.
KeyRingImportJob.reference(String urn): Creates a typed reference to an existing KeyRingImportJob resource.

Properties

attestations ↔ Output<List<KeyRingImportJobAttestation>>: Statement that was generated and signed by the key creator (for example, an HSM) at key creation time. Use this statement to verify attributes of the key as stored on the HSM, independently of Google. Only present if the chosen ImportMethod is one with a protection level of HSM. Structure is documented below.
latefinal
childResources → Set<Resource>: finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>: latefinalinherited
deletionPolicy ↔ Output<String>: Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
latefinal
expireTime ↔ Output<String>: The time at which this resource is scheduled for expiration and can no longer be used. This is in RFC3339 text format.
latefinal
hashCode → int: The hash code for this object.
no setterinherited
id ↔ Output<String>: getter/setter pairinherited
importJobId ↔ Output<String>: It must be unique within a KeyRing and match the regular expression a-zA-Z0-9_-{1,63}
latefinal
importMethod ↔ Output<String>: The wrapping method to be used for incoming key material. Possible values are: RSA_OAEP_3072_SHA1_AES_256, RSA_OAEP_4096_SHA1_AES_256, RSA_OAEP_3072_SHA256_AES_256, RSA_OAEP_4096_SHA256_AES_256, RSA_OAEP_3072_SHA256, RSA_OAEP_4096_SHA256.
latefinal
isCustom → bool: Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool: Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool: Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool: Whether this instance represents a resource value returned over RPC.
finalinherited
keyRing ↔ Output<String>: The KeyRing that this import job belongs to. Format: 'projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}'.
latefinal
name ↔ Output<String>: The resource name for this ImportJob in the format projects//locations//keyRings//importJobs/.
latefinal
protectionLevel ↔ Output<String>: The protection level of the ImportJob. This must match the protectionLevel of the versionTemplate on the CryptoKey you attempt to import into. Possible values are: SOFTWARE, HSM, EXTERNAL.
latefinal
publicKeys ↔ Output<List<KeyRingImportJobPublicKey>>: The public key with which to wrap key material prior to import. Only returned if state is ACTIVE. Structure is documented below.
latefinal
resourceTransforms → List<ResourceTransform>: Inherited/explicit async transforms.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
state ↔ Output<String>: The current state of the ImportJob, indicating if it can be used.
latefinal
transformations → List<ResourceTransformation>: Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>: latefinalinherited

Methods

failId(Object error) → void: Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void: Completes all output properties with error.
inherited
failUrn(Object error) → void: Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?: Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String: Returns this resource's logical name.
inherited
getResourceType() → String: Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>: Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void: Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void: Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void: Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>: Serializes resource properties for RPC transmission.
inherited
toString() → String: A string representation of this object.
inherited

Operators

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

Static Methods

get(String name, Input<String> id, {KeyRingImportJobState? state, CustomResourceOptions? options}) → KeyRingImportJob: Gets an existing KeyRingImportJob resource's state with the given name and id.