| Package | Description |
|---|---|
| com.amazonaws.services.kms.model |
| Modifier and Type | Method and Description |
|---|---|
KeyMetadata |
KeyMetadata.clone() |
KeyMetadata |
CreateKeyResult.getKeyMetadata()
Metadata associated with the KMS key.
|
KeyMetadata |
DescribeKeyResult.getKeyMetadata()
Metadata associated with the key.
|
KeyMetadata |
ReplicateKeyResult.getReplicaKeyMetadata()
Displays details about the new replica key, including its Amazon Resource Name (key ARN) and Key states of KMS keys.
|
KeyMetadata |
KeyMetadata.withArn(String arn)
The Amazon Resource Name (ARN) of the KMS key.
|
KeyMetadata |
KeyMetadata.withAWSAccountId(String aWSAccountId)
The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.
|
KeyMetadata |
KeyMetadata.withCloudHsmClusterId(String cloudHsmClusterId)
The cluster ID of the CloudHSM cluster that contains the key material for the KMS key.
|
KeyMetadata |
KeyMetadata.withCreationDate(Date creationDate)
The date and time when the KMS key was created.
|
KeyMetadata |
KeyMetadata.withCustomerMasterKeySpec(CustomerMasterKeySpec customerMasterKeySpec)
Deprecated.
|
KeyMetadata |
KeyMetadata.withCustomerMasterKeySpec(String customerMasterKeySpec)
Deprecated.
|
KeyMetadata |
KeyMetadata.withCustomKeyStoreId(String customKeyStoreId)
A unique identifier for the custom key store
that contains the KMS key.
|
KeyMetadata |
KeyMetadata.withDeletionDate(Date deletionDate)
The date and time after which KMS deletes this KMS key.
|
KeyMetadata |
KeyMetadata.withDescription(String description)
The description of the KMS key.
|
KeyMetadata |
KeyMetadata.withEnabled(Boolean enabled)
Specifies whether the KMS key is enabled.
|
KeyMetadata |
KeyMetadata.withEncryptionAlgorithms(Collection<String> encryptionAlgorithms)
The encryption algorithms that the KMS key supports.
|
KeyMetadata |
KeyMetadata.withEncryptionAlgorithms(EncryptionAlgorithmSpec... encryptionAlgorithms)
The encryption algorithms that the KMS key supports.
|
KeyMetadata |
KeyMetadata.withEncryptionAlgorithms(String... encryptionAlgorithms)
The encryption algorithms that the KMS key supports.
|
KeyMetadata |
KeyMetadata.withExpirationModel(ExpirationModelType expirationModel)
Specifies whether the KMS key's key material expires.
|
KeyMetadata |
KeyMetadata.withExpirationModel(String expirationModel)
Specifies whether the KMS key's key material expires.
|
KeyMetadata |
KeyMetadata.withKeyAgreementAlgorithms(Collection<String> keyAgreementAlgorithms)
The key agreement algorithm used to derive a shared secret.
|
KeyMetadata |
KeyMetadata.withKeyAgreementAlgorithms(KeyAgreementAlgorithmSpec... keyAgreementAlgorithms)
The key agreement algorithm used to derive a shared secret.
|
KeyMetadata |
KeyMetadata.withKeyAgreementAlgorithms(String... keyAgreementAlgorithms)
The key agreement algorithm used to derive a shared secret.
|
KeyMetadata |
KeyMetadata.withKeyId(String keyId)
The globally unique identifier for the KMS key.
|
KeyMetadata |
KeyMetadata.withKeyManager(KeyManagerType keyManager)
The manager of the KMS key.
|
KeyMetadata |
KeyMetadata.withKeyManager(String keyManager)
The manager of the KMS key.
|
KeyMetadata |
KeyMetadata.withKeySpec(KeySpec keySpec)
Describes the type of key material in the KMS key.
|
KeyMetadata |
KeyMetadata.withKeySpec(String keySpec)
Describes the type of key material in the KMS key.
|
KeyMetadata |
KeyMetadata.withKeyState(KeyState keyState)
The current status of the KMS key.
|
KeyMetadata |
KeyMetadata.withKeyState(String keyState)
The current status of the KMS key.
|
KeyMetadata |
KeyMetadata.withKeyUsage(KeyUsageType keyUsage)
The
cryptographic operations for which you can use the KMS key.
|
KeyMetadata |
KeyMetadata.withKeyUsage(String keyUsage)
The
cryptographic operations for which you can use the KMS key.
|
KeyMetadata |
KeyMetadata.withMacAlgorithms(Collection<String> macAlgorithms)
The message authentication code (MAC) algorithm that the HMAC KMS key supports.
|
KeyMetadata |
KeyMetadata.withMacAlgorithms(MacAlgorithmSpec... macAlgorithms)
The message authentication code (MAC) algorithm that the HMAC KMS key supports.
|
KeyMetadata |
KeyMetadata.withMacAlgorithms(String... macAlgorithms)
The message authentication code (MAC) algorithm that the HMAC KMS key supports.
|
KeyMetadata |
KeyMetadata.withMultiRegion(Boolean multiRegion)
Indicates whether the KMS key is a multi-Region (
True) or regional (False) key. |
KeyMetadata |
KeyMetadata.withMultiRegionConfiguration(MultiRegionConfiguration multiRegionConfiguration)
Lists the primary and replica keys in same multi-Region key.
|
KeyMetadata |
KeyMetadata.withOrigin(OriginType origin)
The source of the key material for the KMS key.
|
KeyMetadata |
KeyMetadata.withOrigin(String origin)
The source of the key material for the KMS key.
|
KeyMetadata |
KeyMetadata.withPendingDeletionWindowInDays(Integer pendingDeletionWindowInDays)
The waiting period before the primary key in a multi-Region key is deleted.
|
KeyMetadata |
KeyMetadata.withSigningAlgorithms(Collection<String> signingAlgorithms)
The signing algorithms that the KMS key supports.
|
KeyMetadata |
KeyMetadata.withSigningAlgorithms(SigningAlgorithmSpec... signingAlgorithms)
The signing algorithms that the KMS key supports.
|
KeyMetadata |
KeyMetadata.withSigningAlgorithms(String... signingAlgorithms)
The signing algorithms that the KMS key supports.
|
KeyMetadata |
KeyMetadata.withValidTo(Date validTo)
The time at which the imported key material expires.
|
KeyMetadata |
KeyMetadata.withXksKeyConfiguration(XksKeyConfigurationType xksKeyConfiguration)
Information about the external key that is associated with a KMS key in an external key store.
|
| Modifier and Type | Method and Description |
|---|---|
void |
CreateKeyResult.setKeyMetadata(KeyMetadata keyMetadata)
Metadata associated with the KMS key.
|
void |
DescribeKeyResult.setKeyMetadata(KeyMetadata keyMetadata)
Metadata associated with the key.
|
void |
ReplicateKeyResult.setReplicaKeyMetadata(KeyMetadata replicaKeyMetadata)
Displays details about the new replica key, including its Amazon Resource Name (key ARN) and Key states of KMS keys.
|
CreateKeyResult |
CreateKeyResult.withKeyMetadata(KeyMetadata keyMetadata)
Metadata associated with the KMS key.
|
DescribeKeyResult |
DescribeKeyResult.withKeyMetadata(KeyMetadata keyMetadata)
Metadata associated with the key.
|
ReplicateKeyResult |
ReplicateKeyResult.withReplicaKeyMetadata(KeyMetadata replicaKeyMetadata)
Displays details about the new replica key, including its Amazon Resource Name (key ARN) and Key states of KMS keys.
|
Copyright © 2025. All rights reserved.