Package software.amazon.awssdk.services.kms.model

Interface RotationsListEntry.Builder

All Superinterfaces:

Buildable, CopyableBuilder<RotationsListEntry.Builder,RotationsListEntry>, SdkBuilder<RotationsListEntry.Builder,RotationsListEntry>, SdkPojo

Enclosing class:

RotationsListEntry

@Mutable
@NotThreadSafe
public static interface RotationsListEntry.Builder
extends SdkPojo, CopyableBuilder<RotationsListEntry.Builder,RotationsListEntry>

Method Summary

Modifier and Type	Method	Description
RotationsListEntry.Builder	expirationModel(String expirationModel)	Indicates if the key material is configured to automatically expire.
RotationsListEntry.Builder	expirationModel(ExpirationModelType expirationModel)	Indicates if the key material is configured to automatically expire.
RotationsListEntry.Builder	importState(String importState)	Indicates if the key material is currently imported into KMS.
RotationsListEntry.Builder	importState(ImportState importState)	Indicates if the key material is currently imported into KMS.
RotationsListEntry.Builder	keyId(String keyId)	Unique identifier of the key.
RotationsListEntry.Builder	keyMaterialDescription(String keyMaterialDescription)	User-specified description of the key material.
RotationsListEntry.Builder	keyMaterialId(String keyMaterialId)	Unique identifier of the key material.
RotationsListEntry.Builder	keyMaterialState(String keyMaterialState)	There are four possible values for this field: CURRENT, NON_CURRENT, PENDING_MULTI_REGION_IMPORT_AND_ROTATION and PENDING_ROTATION.
RotationsListEntry.Builder	keyMaterialState(KeyMaterialState keyMaterialState)	There are four possible values for this field: CURRENT, NON_CURRENT, PENDING_MULTI_REGION_IMPORT_AND_ROTATION and PENDING_ROTATION.
RotationsListEntry.Builder	rotationDate(Instant rotationDate)	Date and time that the key material rotation completed.
RotationsListEntry.Builder	rotationType(String rotationType)	Identifies whether the key material rotation was a scheduled automatic rotation or an on-demand rotation.
RotationsListEntry.Builder	rotationType(RotationType rotationType)	Identifies whether the key material rotation was a scheduled automatic rotation or an on-demand rotation.
RotationsListEntry.Builder	validTo(Instant validTo)	Date and time at which the key material expires.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

keyId

RotationsListEntry.Builder keyId(String keyId)

Unique identifier of the key.

Parameters:

keyId - Unique identifier of the key.

Returns:

Returns a reference to this object so that method calls can be chained together.

keyMaterialId

RotationsListEntry.Builder keyMaterialId(String keyMaterialId)

Unique identifier of the key material.

Parameters:

keyMaterialId - Unique identifier of the key material.

Returns:

Returns a reference to this object so that method calls can be chained together.

keyMaterialDescription

RotationsListEntry.Builder keyMaterialDescription(String keyMaterialDescription)

User-specified description of the key material. This field is only present for symmetric encryption KMS keys with EXTERNAL origin.

Parameters:

keyMaterialDescription - User-specified description of the key material. This field is only present for symmetric encryption KMS keys with EXTERNAL origin.

Returns:

Returns a reference to this object so that method calls can be chained together.

importState

RotationsListEntry.Builder importState(String importState)

Indicates if the key material is currently imported into KMS. It has two possible values: IMPORTED or PENDING_IMPORT. This field is only present for symmetric encryption KMS keys with EXTERNAL origin.

Parameters:

importState - Indicates if the key material is currently imported into KMS. It has two possible values: IMPORTED or PENDING_IMPORT. This field is only present for symmetric encryption KMS keys with EXTERNAL origin.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ImportState, ImportState

importState

RotationsListEntry.Builder importState(ImportState importState)

Indicates if the key material is currently imported into KMS. It has two possible values: IMPORTED or PENDING_IMPORT. This field is only present for symmetric encryption KMS keys with EXTERNAL origin.

Parameters:

importState - Indicates if the key material is currently imported into KMS. It has two possible values: IMPORTED or PENDING_IMPORT. This field is only present for symmetric encryption KMS keys with EXTERNAL origin.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ImportState, ImportState

keyMaterialState

RotationsListEntry.Builder keyMaterialState(String keyMaterialState)

There are four possible values for this field: CURRENT, NON_CURRENT, PENDING_MULTI_REGION_IMPORT_AND_ROTATION and PENDING_ROTATION. KMS uses CURRENT key material for both encryption and decryption and NON_CURRENT key material only for decryption. PENDING_ROTATION identifies key material that has been imported for on-demand key rotation but the rotation hasn't completed. The key material state PENDING_MULTI_REGION_IMPORT_AND_ROTATION is unique to multi-region, symmetric encryption keys with imported key material. It indicates key material that has been imported into the primary Region key but not all of the replica Region keys. When this key material is imported in to all of the replica Region keys, the key material state will change to PENDING_ROTATION. Key material in PENDING_MULTI_REGION_IMPORT_AND_ROTATION or PENDING_ROTATION state is not permanently associated with the KMS key. You can delete this key material and import different key material in its place. The PENDING_MULTI_REGION_IMPORT_AND_ROTATION and PENDING_ROTATION values are only used in symmetric encryption keys with imported key material. The other values, CURRENT and NON_CURRENT, are used for all KMS keys that support automatic or on-demand key rotation.

Parameters:

keyMaterialState - There are four possible values for this field: CURRENT, NON_CURRENT, PENDING_MULTI_REGION_IMPORT_AND_ROTATION and PENDING_ROTATION. KMS uses CURRENT key material for both encryption and decryption and NON_CURRENT key material only for decryption. PENDING_ROTATION identifies key material that has been imported for on-demand key rotation but the rotation hasn't completed. The key material state PENDING_MULTI_REGION_IMPORT_AND_ROTATION is unique to multi-region, symmetric encryption keys with imported key material. It indicates key material that has been imported into the primary Region key but not all of the replica Region keys. When this key material is imported in to all of the replica Region keys, the key material state will change to PENDING_ROTATION. Key material in PENDING_MULTI_REGION_IMPORT_AND_ROTATION or PENDING_ROTATION state is not permanently associated with the KMS key. You can delete this key material and import different key material in its place. The PENDING_MULTI_REGION_IMPORT_AND_ROTATION and PENDING_ROTATION values are only used in symmetric encryption keys with imported key material. The other values, CURRENT and NON_CURRENT, are used for all KMS keys that support automatic or on-demand key rotation.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

KeyMaterialState, KeyMaterialState

keyMaterialState

RotationsListEntry.Builder keyMaterialState(KeyMaterialState keyMaterialState)

There are four possible values for this field: CURRENT, NON_CURRENT, PENDING_MULTI_REGION_IMPORT_AND_ROTATION and PENDING_ROTATION. KMS uses CURRENT key material for both encryption and decryption and NON_CURRENT key material only for decryption. PENDING_ROTATION identifies key material that has been imported for on-demand key rotation but the rotation hasn't completed. The key material state PENDING_MULTI_REGION_IMPORT_AND_ROTATION is unique to multi-region, symmetric encryption keys with imported key material. It indicates key material that has been imported into the primary Region key but not all of the replica Region keys. When this key material is imported in to all of the replica Region keys, the key material state will change to PENDING_ROTATION. Key material in PENDING_MULTI_REGION_IMPORT_AND_ROTATION or PENDING_ROTATION state is not permanently associated with the KMS key. You can delete this key material and import different key material in its place. The PENDING_MULTI_REGION_IMPORT_AND_ROTATION and PENDING_ROTATION values are only used in symmetric encryption keys with imported key material. The other values, CURRENT and NON_CURRENT, are used for all KMS keys that support automatic or on-demand key rotation.

Parameters:

keyMaterialState - There are four possible values for this field: CURRENT, NON_CURRENT, PENDING_MULTI_REGION_IMPORT_AND_ROTATION and PENDING_ROTATION. KMS uses CURRENT key material for both encryption and decryption and NON_CURRENT key material only for decryption. PENDING_ROTATION identifies key material that has been imported for on-demand key rotation but the rotation hasn't completed. The key material state PENDING_MULTI_REGION_IMPORT_AND_ROTATION is unique to multi-region, symmetric encryption keys with imported key material. It indicates key material that has been imported into the primary Region key but not all of the replica Region keys. When this key material is imported in to all of the replica Region keys, the key material state will change to PENDING_ROTATION. Key material in PENDING_MULTI_REGION_IMPORT_AND_ROTATION or PENDING_ROTATION state is not permanently associated with the KMS key. You can delete this key material and import different key material in its place. The PENDING_MULTI_REGION_IMPORT_AND_ROTATION and PENDING_ROTATION values are only used in symmetric encryption keys with imported key material. The other values, CURRENT and NON_CURRENT, are used for all KMS keys that support automatic or on-demand key rotation.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

KeyMaterialState, KeyMaterialState

expirationModel

RotationsListEntry.Builder expirationModel(String expirationModel)

Indicates if the key material is configured to automatically expire. There are two possible values for this field: KEY_MATERIAL_EXPIRES and KEY_MATERIAL_DOES_NOT_EXPIRE. For any key material that expires, the expiration date and time is indicated in ValidTo. This field is only present for symmetric encryption KMS keys with EXTERNAL origin.

Parameters:

expirationModel - Indicates if the key material is configured to automatically expire. There are two possible values for this field: KEY_MATERIAL_EXPIRES and KEY_MATERIAL_DOES_NOT_EXPIRE. For any key material that expires, the expiration date and time is indicated in ValidTo. This field is only present for symmetric encryption KMS keys with EXTERNAL origin.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ExpirationModelType, ExpirationModelType

expirationModel

RotationsListEntry.Builder expirationModel(ExpirationModelType expirationModel)

Indicates if the key material is configured to automatically expire. There are two possible values for this field: KEY_MATERIAL_EXPIRES and KEY_MATERIAL_DOES_NOT_EXPIRE. For any key material that expires, the expiration date and time is indicated in ValidTo. This field is only present for symmetric encryption KMS keys with EXTERNAL origin.

Parameters:

expirationModel - Indicates if the key material is configured to automatically expire. There are two possible values for this field: KEY_MATERIAL_EXPIRES and KEY_MATERIAL_DOES_NOT_EXPIRE. For any key material that expires, the expiration date and time is indicated in ValidTo. This field is only present for symmetric encryption KMS keys with EXTERNAL origin.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ExpirationModelType, ExpirationModelType

validTo

RotationsListEntry.Builder validTo(Instant validTo)

Date and time at which the key material expires. This field is only present for symmetric encryption KMS keys with EXTERNAL origin in rotation list entries with an ExpirationModel value of KEY_MATERIAL_EXPIRES.

Parameters:

validTo - Date and time at which the key material expires. This field is only present for symmetric encryption KMS keys with EXTERNAL origin in rotation list entries with an ExpirationModel value of KEY_MATERIAL_EXPIRES.

Returns:

Returns a reference to this object so that method calls can be chained together.

rotationDate

RotationsListEntry.Builder rotationDate(Instant rotationDate)

Date and time that the key material rotation completed. Formatted as Unix time. This field is not present for the first key material or an imported key material in PENDING_ROTATION state.

Parameters:

rotationDate - Date and time that the key material rotation completed. Formatted as Unix time. This field is not present for the first key material or an imported key material in PENDING_ROTATION state.

Returns:

Returns a reference to this object so that method calls can be chained together.

rotationType

RotationsListEntry.Builder rotationType(String rotationType)

Identifies whether the key material rotation was a scheduled automatic rotation or an on-demand rotation. This field is not present for the first key material or an imported key material in PENDING_ROTATION state.

Parameters:

rotationType - Identifies whether the key material rotation was a scheduled automatic rotation or an on-demand rotation. This field is not present for the first key material or an imported key material in PENDING_ROTATION state.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RotationType, RotationType

rotationType

RotationsListEntry.Builder rotationType(RotationType rotationType)

Identifies whether the key material rotation was a scheduled automatic rotation or an on-demand rotation. This field is not present for the first key material or an imported key material in PENDING_ROTATION state.

Parameters:

rotationType - Identifies whether the key material rotation was a scheduled automatic rotation or an on-demand rotation. This field is not present for the first key material or an imported key material in PENDING_ROTATION state.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RotationType, RotationType