kms library

Classes

Alias
Provides an alias for a KMS customer master key. AWS Console enforces 1-to-1 mapping between aliases & keys, but API (hence this provider too) allows you to create as many aliases as the account limits allow you.
AliasArgs
The set of arguments for Alias. The set of arguments for Alias.
AliasState
Input properties used for looking up and filtering Alias resources.
Ciphertext
The KMS ciphertext resource allows you to encrypt plaintext into ciphertext by using an AWS KMS customer master key. The value returned by this resource is stable across every apply. For a changing ciphertext value each apply, see the aws.kms.Ciphertext data source.
CiphertextArgs
The set of arguments for Ciphertext. The set of arguments for Ciphertext.
CiphertextState
Input properties used for looking up and filtering Ciphertext resources.
CustomKeyStore
Resource for managing an AWS KMS (Key Management) Custom Key Store.
CustomKeyStoreArgs
The set of arguments for CustomKeyStore. The set of arguments for CustomKeyStore.
CustomKeyStoreState
Input properties used for looking up and filtering CustomKeyStore resources.
CustomKeyStoreXksProxyAuthenticationCredential
ExternalKey
Manages a single-Region or multi-Region primary KMS key that uses external key material. To instead manage a single-Region or multi-Region primary KMS key where AWS automatically generates and potentially rotates key material, see the aws.kms.Key resource.
ExternalKeyArgs
The set of arguments for ExternalKey. The set of arguments for ExternalKey.
ExternalKeyState
Input properties used for looking up and filtering ExternalKey resources.
GetAliasArgs
Arguments for getAlias. Arguments for getAlias.
GetAliasResult
Result data returned by getAlias.
GetCipherTextArgs
Arguments for getCipherText. Arguments for getCipherText.
GetCipherTextResult
Result data returned by getCipherText.
GetCustomKeyStoreArgs
Arguments for getCustomKeyStore. Arguments for getCustomKeyStore.
GetCustomKeyStoreResult
Result data returned by getCustomKeyStore.
GetKeyArgs
Arguments for getKey. Arguments for getKey.
GetKeyMultiRegionConfiguration
GetKeyMultiRegionConfigurationPrimaryKey
GetKeyMultiRegionConfigurationReplicaKey
GetKeyResult
Result data returned by getKey.
GetKeyXksKeyConfiguration
GetPublicKeyArgs
Arguments for getPublicKey. Arguments for getPublicKey.
GetPublicKeyResult
Result data returned by getPublicKey.
GetSecretArgs
Arguments for getSecret. Arguments for getSecret.
GetSecretResult
Result data returned by getSecret.
GetSecretsArgs
Arguments for getSecrets. Arguments for getSecrets.
GetSecretSecret
GetSecretsResult
Result data returned by getSecrets.
GetSecretsSecret
Grant
Provides a resource-based access control mechanism for a KMS customer master key.
GrantArgs
The set of arguments for Grant. The set of arguments for Grant.
GrantConstraint
GrantState
Input properties used for looking up and filtering Grant resources.
Key
Manages a single-Region or multi-Region primary KMS key.
KeyArgs
The set of arguments for Key. The set of arguments for Key.
KeyPolicy
Attaches a policy to a KMS Key.
KeyPolicyArgs
The set of arguments for KeyPolicy. The set of arguments for KeyPolicy.
KeyPolicyState
Input properties used for looking up and filtering KeyPolicy resources.
KeyState
Input properties used for looking up and filtering Key resources.
ReplicaExternalKey
Manages a KMS multi-Region replica key that uses external key material. See the AWS KMS Developer Guide for more information on importing key material into multi-Region keys.
ReplicaExternalKeyArgs
The set of arguments for ReplicaExternalKey. The set of arguments for ReplicaExternalKey.
ReplicaExternalKeyState
Input properties used for looking up and filtering ReplicaExternalKey resources.
ReplicaKey
Manages a KMS multi-Region replica key.
ReplicaKeyArgs
The set of arguments for ReplicaKey. The set of arguments for ReplicaKey.
ReplicaKeyState
Input properties used for looking up and filtering ReplicaKey resources.

Functions

getAlias(GetAliasArgs args, {InvokeOptions? options}) → Future<GetAliasResult>
Use this data source to get the ARN of a KMS key alias. By using this data source, you can reference key alias without having to hard code the ARN as input.
getAliasOutput(GetAliasArgs args, {InvokeOutputOptions? options}) → Output<GetAliasResult>
getCipherText(GetCipherTextArgs args, {InvokeOptions? options}) → Future<GetCipherTextResult>
The KMS ciphertext data source allows you to encrypt plaintext into ciphertext by using an AWS KMS customer master key. The value returned by this data source changes every apply. For a stable ciphertext value, see the aws.kms.Ciphertext resource.
getCipherTextOutput(GetCipherTextArgs args, {InvokeOutputOptions? options}) → Output<GetCipherTextResult>
getCustomKeyStore(GetCustomKeyStoreArgs args, {InvokeOptions? options}) → Future<GetCustomKeyStoreResult>
Use this data source to get the metadata KMS custom key store. By using this data source, you can reference KMS custom key store without having to hard code the ID as input.
getCustomKeyStoreOutput(GetCustomKeyStoreArgs args, {InvokeOutputOptions? options}) → Output<GetCustomKeyStoreResult>
getKey(GetKeyArgs args, {InvokeOptions? options}) → Future<GetKeyResult>
Use this data source to get detailed information about the specified KMS Key with flexible key id input. This can be useful to reference key alias without having to hard code the ARN as input.
getKeyOutput(GetKeyArgs args, {InvokeOutputOptions? options}) → Output<GetKeyResult>
getPublicKey(GetPublicKeyArgs args, {InvokeOptions? options}) → Future<GetPublicKeyResult>
Use this data source to get the public key about the specified KMS Key with flexible key id input. This can be useful to reference key alias without having to hard code the ARN as input.
getPublicKeyOutput(GetPublicKeyArgs args, {InvokeOutputOptions? options}) → Output<GetPublicKeyResult>
getSecret(GetSecretArgs args, {InvokeOptions? options}) → Future<GetSecretResult>
> WARNING: This data source's functionality was removed in version 2.0.0 of the AWS Provider. You can migrate existing configurations to the aws.kms.getSecrets data source following instructions available in the Version 2 Upgrade Guide. This data source will be removed in a future version. args Arguments passed to this invoke. Arguments for getSecret. options Invoke options controlling this call.
getSecretOutput(GetSecretArgs args, {InvokeOutputOptions? options}) → Output<GetSecretResult>
getSecrets(GetSecretsArgs args, {InvokeOptions? options}) → Future<GetSecretsResult>
Decrypt multiple secrets from data encrypted with the AWS KMS service.
getSecretsOutput(GetSecretsArgs args, {InvokeOutputOptions? options}) → Output<GetSecretsResult>