| Package | Description |
|---|---|
| software.amazon.awssdk.services.kms.model |
| Modifier and Type | Method and Description |
|---|---|
KeyMetadata.Builder |
KeyMetadata.Builder.arn(String arn)
The Amazon Resource Name (ARN) of the KMS key.
|
KeyMetadata.Builder |
KeyMetadata.Builder.awsAccountId(String awsAccountId)
The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.
|
static KeyMetadata.Builder |
KeyMetadata.builder() |
KeyMetadata.Builder |
KeyMetadata.Builder.cloudHsmClusterId(String cloudHsmClusterId)
The cluster ID of the CloudHSM cluster that contains the key material for the KMS key.
|
KeyMetadata.Builder |
KeyMetadata.Builder.creationDate(Instant creationDate)
The date and time when the KMS key was created.
|
KeyMetadata.Builder |
KeyMetadata.Builder.customerMasterKeySpec(CustomerMasterKeySpec customerMasterKeySpec)
Deprecated.
This field has been deprecated. Instead, use the KeySpec field.
|
KeyMetadata.Builder |
KeyMetadata.Builder.customerMasterKeySpec(String customerMasterKeySpec)
Deprecated.
This field has been deprecated. Instead, use the KeySpec field.
|
KeyMetadata.Builder |
KeyMetadata.Builder.customKeyStoreId(String customKeyStoreId)
A unique identifier for the custom key
store that contains the KMS key.
|
KeyMetadata.Builder |
KeyMetadata.Builder.deletionDate(Instant deletionDate)
The date and time after which KMS deletes this KMS key.
|
KeyMetadata.Builder |
KeyMetadata.Builder.description(String description)
The description of the KMS key.
|
KeyMetadata.Builder |
KeyMetadata.Builder.enabled(Boolean enabled)
Specifies whether the KMS key is enabled.
|
KeyMetadata.Builder |
KeyMetadata.Builder.encryptionAlgorithms(Collection<EncryptionAlgorithmSpec> encryptionAlgorithms)
The encryption algorithms that the KMS key supports.
|
KeyMetadata.Builder |
KeyMetadata.Builder.encryptionAlgorithms(EncryptionAlgorithmSpec... encryptionAlgorithms)
The encryption algorithms that the KMS key supports.
|
KeyMetadata.Builder |
KeyMetadata.Builder.encryptionAlgorithmsWithStrings(Collection<String> encryptionAlgorithms)
The encryption algorithms that the KMS key supports.
|
KeyMetadata.Builder |
KeyMetadata.Builder.encryptionAlgorithmsWithStrings(String... encryptionAlgorithms)
The encryption algorithms that the KMS key supports.
|
KeyMetadata.Builder |
KeyMetadata.Builder.expirationModel(ExpirationModelType expirationModel)
Specifies whether the KMS key's key material expires.
|
KeyMetadata.Builder |
KeyMetadata.Builder.expirationModel(String expirationModel)
Specifies whether the KMS key's key material expires.
|
KeyMetadata.Builder |
KeyMetadata.Builder.keyId(String keyId)
The globally unique identifier for the KMS key.
|
KeyMetadata.Builder |
KeyMetadata.Builder.keyManager(KeyManagerType keyManager)
The manager of the KMS key.
|
KeyMetadata.Builder |
KeyMetadata.Builder.keyManager(String keyManager)
The manager of the KMS key.
|
KeyMetadata.Builder |
KeyMetadata.Builder.keySpec(KeySpec keySpec)
Describes the type of key material in the KMS key.
|
KeyMetadata.Builder |
KeyMetadata.Builder.keySpec(String keySpec)
Describes the type of key material in the KMS key.
|
KeyMetadata.Builder |
KeyMetadata.Builder.keyState(KeyState keyState)
The current status of the KMS key.
|
KeyMetadata.Builder |
KeyMetadata.Builder.keyState(String keyState)
The current status of the KMS key.
|
KeyMetadata.Builder |
KeyMetadata.Builder.keyUsage(KeyUsageType keyUsage)
The
cryptographic operations for which you can use the KMS key.
|
KeyMetadata.Builder |
KeyMetadata.Builder.keyUsage(String keyUsage)
The
cryptographic operations for which you can use the KMS key.
|
KeyMetadata.Builder |
KeyMetadata.Builder.macAlgorithms(Collection<MacAlgorithmSpec> macAlgorithms)
The message authentication code (MAC) algorithm that the HMAC KMS key supports.
|
KeyMetadata.Builder |
KeyMetadata.Builder.macAlgorithms(MacAlgorithmSpec... macAlgorithms)
The message authentication code (MAC) algorithm that the HMAC KMS key supports.
|
KeyMetadata.Builder |
KeyMetadata.Builder.macAlgorithmsWithStrings(Collection<String> macAlgorithms)
The message authentication code (MAC) algorithm that the HMAC KMS key supports.
|
KeyMetadata.Builder |
KeyMetadata.Builder.macAlgorithmsWithStrings(String... macAlgorithms)
The message authentication code (MAC) algorithm that the HMAC KMS key supports.
|
KeyMetadata.Builder |
KeyMetadata.Builder.multiRegion(Boolean multiRegion)
Indicates whether the KMS key is a multi-Region (
True) or regional (False) key. |
default KeyMetadata.Builder |
KeyMetadata.Builder.multiRegionConfiguration(Consumer<MultiRegionConfiguration.Builder> multiRegionConfiguration)
Lists the primary and replica keys in same multi-Region key.
|
KeyMetadata.Builder |
KeyMetadata.Builder.multiRegionConfiguration(MultiRegionConfiguration multiRegionConfiguration)
Lists the primary and replica keys in same multi-Region key.
|
KeyMetadata.Builder |
KeyMetadata.Builder.origin(OriginType origin)
The source of the key material for the KMS key.
|
KeyMetadata.Builder |
KeyMetadata.Builder.origin(String origin)
The source of the key material for the KMS key.
|
KeyMetadata.Builder |
KeyMetadata.Builder.pendingDeletionWindowInDays(Integer pendingDeletionWindowInDays)
The waiting period before the primary key in a multi-Region key is deleted.
|
KeyMetadata.Builder |
KeyMetadata.Builder.signingAlgorithms(Collection<SigningAlgorithmSpec> signingAlgorithms)
The signing algorithms that the KMS key supports.
|
KeyMetadata.Builder |
KeyMetadata.Builder.signingAlgorithms(SigningAlgorithmSpec... signingAlgorithms)
The signing algorithms that the KMS key supports.
|
KeyMetadata.Builder |
KeyMetadata.Builder.signingAlgorithmsWithStrings(Collection<String> signingAlgorithms)
The signing algorithms that the KMS key supports.
|
KeyMetadata.Builder |
KeyMetadata.Builder.signingAlgorithmsWithStrings(String... signingAlgorithms)
The signing algorithms that the KMS key supports.
|
KeyMetadata.Builder |
KeyMetadata.toBuilder() |
KeyMetadata.Builder |
KeyMetadata.Builder.validTo(Instant validTo)
The time at which the imported key material expires.
|
default KeyMetadata.Builder |
KeyMetadata.Builder.xksKeyConfiguration(Consumer<XksKeyConfigurationType.Builder> xksKeyConfiguration)
Information about the external key that is associated with a KMS key in an external key store.
|
KeyMetadata.Builder |
KeyMetadata.Builder.xksKeyConfiguration(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 |
|---|---|
static Class<? extends KeyMetadata.Builder> |
KeyMetadata.serializableBuilderClass() |
| Modifier and Type | Method and Description |
|---|---|
default CreateKeyResponse.Builder |
CreateKeyResponse.Builder.keyMetadata(Consumer<KeyMetadata.Builder> keyMetadata)
Metadata associated with the KMS key.
|
default DescribeKeyResponse.Builder |
DescribeKeyResponse.Builder.keyMetadata(Consumer<KeyMetadata.Builder> keyMetadata)
Metadata associated with the key.
|
default ReplicateKeyResponse.Builder |
ReplicateKeyResponse.Builder.replicaKeyMetadata(Consumer<KeyMetadata.Builder> replicaKeyMetadata)
Displays details about the new replica key, including its Amazon Resource Name (key ARN) and Key states of KMS keys.
|
Copyright © 2023. All rights reserved.