software.amazon.awssdk.services.secretsmanager.model

Interface SecretListEntry.Builder

All Superinterfaces:

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

Enclosing class:

SecretListEntry

public static interface SecretListEntry.Builder
extends SdkPojo, CopyableBuilder<SecretListEntry.Builder,SecretListEntry>

Method Summary

Modifier and Type	Method and Description
SecretListEntry.Builder	arn(String arn) The Amazon Resource Name (ARN) of the secret.
SecretListEntry.Builder	createdDate(Instant createdDate) The date and time when a secret was created.
SecretListEntry.Builder	deletedDate(Instant deletedDate) The date and time the deletion of the secret occurred.
SecretListEntry.Builder	description(String description) The user-provided description of the secret.
SecretListEntry.Builder	kmsKeyId(String kmsKeyId) The ARN of the KMS key that Secrets Manager uses to encrypt the secret value.
SecretListEntry.Builder	lastAccessedDate(Instant lastAccessedDate) The date that the secret was last accessed in the Region.
SecretListEntry.Builder	lastChangedDate(Instant lastChangedDate) The last date and time that this secret was modified in any way.
SecretListEntry.Builder	lastRotatedDate(Instant lastRotatedDate) The most recent date and time that the Secrets Manager rotation process was successfully completed.
SecretListEntry.Builder	name(String name) The friendly name of the secret.
SecretListEntry.Builder	nextRotationDate(Instant nextRotationDate) The next date and time that Secrets Manager will attempt to rotate the secret, rounded to the nearest hour.
SecretListEntry.Builder	owningService(String owningService) Returns the name of the service that created the secret.
SecretListEntry.Builder	primaryRegion(String primaryRegion) The Region where Secrets Manager originated the secret.
SecretListEntry.Builder	rotationEnabled(Boolean rotationEnabled) Indicates whether automatic, scheduled rotation is enabled for this secret.
SecretListEntry.Builder	rotationLambdaARN(String rotationLambdaARN) The ARN of an Amazon Web Services Lambda function invoked by Secrets Manager to rotate and expire the secret either automatically per the schedule or manually by a call to RotateSecret .
default SecretListEntry.Builder	rotationRules(Consumer<RotationRulesType.Builder> rotationRules) A structure that defines the rotation configuration for the secret.
SecretListEntry.Builder	rotationRules(RotationRulesType rotationRules) A structure that defines the rotation configuration for the secret.
SecretListEntry.Builder	secretVersionsToStages(Map<String,? extends Collection<String>> secretVersionsToStages) A list of all of the currently assigned SecretVersionStage staging labels and the SecretVersionId attached to each one.
SecretListEntry.Builder	tags(Collection<Tag> tags) The list of user-defined tags associated with the secret.
SecretListEntry.Builder	tags(Consumer<Tag.Builder>... tags) The list of user-defined tags associated with the secret.
SecretListEntry.Builder	tags(Tag... tags) The list of user-defined tags associated with the secret.

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

arn

SecretListEntry.Builder arn(String arn)

The Amazon Resource Name (ARN) of the secret.

Parameters:

arn - The Amazon Resource Name (ARN) of the secret.

Returns:

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

name

SecretListEntry.Builder name(String name)

The friendly name of the secret. You can use forward slashes in the name to represent a path hierarchy. For example, /prod/databases/dbserver1 could represent the secret for a server named dbserver1 in the folder databases in the folder prod.

Parameters:

name - The friendly name of the secret. You can use forward slashes in the name to represent a path hierarchy. For example, /prod/databases/dbserver1 could represent the secret for a server named dbserver1 in the folder databases in the folder prod.

Returns:

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

description

SecretListEntry.Builder description(String description)

The user-provided description of the secret.

Parameters:

description - The user-provided description of the secret.

Returns:

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

kmsKeyId

SecretListEntry.Builder kmsKeyId(String kmsKeyId)

The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager, this field is omitted.

Parameters:

kmsKeyId - The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager, this field is omitted.

Returns:

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

rotationEnabled

SecretListEntry.Builder rotationEnabled(Boolean rotationEnabled)

Indicates whether automatic, scheduled rotation is enabled for this secret.

Parameters:

rotationEnabled - Indicates whether automatic, scheduled rotation is enabled for this secret.

Returns:

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

rotationLambdaARN

SecretListEntry.Builder rotationLambdaARN(String rotationLambdaARN)

The ARN of an Amazon Web Services Lambda function invoked by Secrets Manager to rotate and expire the secret either automatically per the schedule or manually by a call to RotateSecret .

Parameters:

rotationLambdaARN - The ARN of an Amazon Web Services Lambda function invoked by Secrets Manager to rotate and expire the secret either automatically per the schedule or manually by a call to RotateSecret .

Returns:

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

rotationRules

SecretListEntry.Builder rotationRules(RotationRulesType rotationRules)

A structure that defines the rotation configuration for the secret.

Parameters:

rotationRules - A structure that defines the rotation configuration for the secret.

Returns:

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

rotationRules

default SecretListEntry.Builder rotationRules(Consumer<RotationRulesType.Builder> rotationRules)

A structure that defines the rotation configuration for the secret.

This is a convenience method that creates an instance of the RotationRulesType.Builder avoiding the need to create one manually via RotationRulesType.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to rotationRules(RotationRulesType).

Parameters:

rotationRules - a consumer that will call methods on RotationRulesType.Builder

Returns:

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

See Also:

rotationRules(RotationRulesType)

lastRotatedDate

SecretListEntry.Builder lastRotatedDate(Instant lastRotatedDate)

The most recent date and time that the Secrets Manager rotation process was successfully completed. This value is null if the secret hasn't ever rotated.

Parameters:

lastRotatedDate - The most recent date and time that the Secrets Manager rotation process was successfully completed. This value is null if the secret hasn't ever rotated.

Returns:

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

lastChangedDate

SecretListEntry.Builder lastChangedDate(Instant lastChangedDate)

The last date and time that this secret was modified in any way.

Parameters:

lastChangedDate - The last date and time that this secret was modified in any way.

Returns:

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

lastAccessedDate

SecretListEntry.Builder lastAccessedDate(Instant lastAccessedDate)

The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.

Parameters:

lastAccessedDate - The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.

Returns:

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

deletedDate

SecretListEntry.Builder deletedDate(Instant deletedDate)

The date and time the deletion of the secret occurred. Not present on active secrets. The secret can be recovered until the number of days in the recovery window has passed, as specified in the RecoveryWindowInDays parameter of the DeleteSecret operation.

Parameters:

deletedDate - The date and time the deletion of the secret occurred. Not present on active secrets. The secret can be recovered until the number of days in the recovery window has passed, as specified in the RecoveryWindowInDays parameter of the DeleteSecret operation.

Returns:

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

nextRotationDate

SecretListEntry.Builder nextRotationDate(Instant nextRotationDate)

The next date and time that Secrets Manager will attempt to rotate the secret, rounded to the nearest hour. This value is null if the secret is not set up for rotation.

Parameters:

nextRotationDate - The next date and time that Secrets Manager will attempt to rotate the secret, rounded to the nearest hour. This value is null if the secret is not set up for rotation.

Returns:

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

tags

SecretListEntry.Builder tags(Collection<Tag> tags)

The list of user-defined tags associated with the secret. To add tags to a secret, use TagResource . To remove tags, use UntagResource .

Parameters:

tags - The list of user-defined tags associated with the secret. To add tags to a secret, use TagResource . To remove tags, use UntagResource .

Returns:

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

tags

SecretListEntry.Builder tags(Tag... tags)

The list of user-defined tags associated with the secret. To add tags to a secret, use TagResource . To remove tags, use UntagResource .

Parameters:

tags - The list of user-defined tags associated with the secret. To add tags to a secret, use TagResource . To remove tags, use UntagResource .

Returns:

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

tags

SecretListEntry.Builder tags(Consumer<Tag.Builder>... tags)

The list of user-defined tags associated with the secret. To add tags to a secret, use TagResource . To remove tags, use UntagResource .

This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

#tags(java.util.Collection)

secretVersionsToStages

SecretListEntry.Builder secretVersionsToStages(Map<String,? extends Collection<String>> secretVersionsToStages)

A list of all of the currently assigned SecretVersionStage staging labels and the SecretVersionId attached to each one. Staging labels are used to keep track of the different versions during the rotation process.

A version that does not have any SecretVersionStage is considered deprecated and subject to deletion. Such versions are not included in this list.

Parameters:

secretVersionsToStages - A list of all of the currently assigned SecretVersionStage staging labels and the SecretVersionId attached to each one. Staging labels are used to keep track of the different versions during the rotation process.

A version that does not have any SecretVersionStage is considered deprecated and subject to deletion. Such versions are not included in this list.

Returns:

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

owningService

SecretListEntry.Builder owningService(String owningService)

Returns the name of the service that created the secret.

Parameters:

owningService - Returns the name of the service that created the secret.

Returns:

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

createdDate

SecretListEntry.Builder createdDate(Instant createdDate)

The date and time when a secret was created.

Parameters:

createdDate - The date and time when a secret was created.

Returns:

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

primaryRegion

SecretListEntry.Builder primaryRegion(String primaryRegion)

The Region where Secrets Manager originated the secret.

Parameters:

primaryRegion - The Region where Secrets Manager originated the secret.

Returns:

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