public static interface SecretListEntry.Builder extends SdkPojo, CopyableBuilder<SecretListEntry.Builder,SecretListEntry>
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 or alias of the AWS KMS customer master key (CMK) used to encrypt the
SecretString and
SecretBinary fields in each version of the secret. |
SecretListEntry.Builder |
lastAccessedDate(Instant lastAccessedDate)
The last date that this secret was accessed.
|
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 |
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 AWS 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.
|
equalsBySdkFields, sdkFields
copy
applyMutation, build
SecretListEntry.Builder arn(String arn)
The Amazon Resource Name (ARN) of the secret.
For more information about ARNs in Secrets Manager, see Policy Resources in the AWS Secrets Manager User Guide.
arn
- The Amazon Resource Name (ARN) of the secret.
For more information about ARNs in Secrets Manager, see Policy Resources in the AWS Secrets Manager User Guide.
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
.
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
.SecretListEntry.Builder description(String description)
The user-provided description of the secret.
description
- The user-provided description of the secret.SecretListEntry.Builder kmsKeyId(String kmsKeyId)
The ARN or alias of the AWS KMS customer master key (CMK) used to encrypt the SecretString
and
SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets
Manager defaults to encrypting the secret fields with the default KMS CMK, the key named
awssecretsmanager
, for this account.
kmsKeyId
- The ARN or alias of the AWS KMS customer master key (CMK) used to encrypt the
SecretString
and SecretBinary
fields in each version of the secret. If you
don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default
KMS CMK, the key named awssecretsmanager
, for this account.SecretListEntry.Builder rotationEnabled(Boolean rotationEnabled)
Indicates whether automatic, scheduled rotation is enabled for this secret.
rotationEnabled
- Indicates whether automatic, scheduled rotation is enabled for this secret.SecretListEntry.Builder rotationLambdaARN(String rotationLambdaARN)
The ARN of an AWS Lambda function invoked by Secrets Manager to rotate and expire the secret either automatically per the schedule or manually by a call to RotateSecret.
rotationLambdaARN
- The ARN of an AWS Lambda function invoked by Secrets Manager to rotate and expire the secret either
automatically per the schedule or manually by a call to RotateSecret.SecretListEntry.Builder rotationRules(RotationRulesType rotationRules)
A structure that defines the rotation configuration for the secret.
rotationRules
- A structure that defines the rotation configuration for the secret.default SecretListEntry.Builder rotationRules(Consumer<RotationRulesType.Builder> rotationRules)
A structure that defines the rotation configuration for the secret.
This is a convenience that creates an instance of theRotationRulesType.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)
.rotationRules
- a consumer that will call methods on RotationRulesType.Builder
rotationRules(RotationRulesType)
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.
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.SecretListEntry.Builder lastChangedDate(Instant lastChangedDate)
The last date and time that this secret was modified in any way.
lastChangedDate
- The last date and time that this secret was modified in any way.SecretListEntry.Builder lastAccessedDate(Instant lastAccessedDate)
The last date that this secret was accessed. This value is truncated to midnight of the date and therefore shows only the date, not the time.
lastAccessedDate
- The last date that this secret was accessed. This value is truncated to midnight of the date and
therefore shows only the date, not the time.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.
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.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.
tags
- The list of user-defined tags associated with the secret. To add tags to a secret, use
TagResource. To remove tags, use UntagResource.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.
tags
- The list of user-defined tags associated with the secret. To add tags to a secret, use
TagResource. To remove tags, use UntagResource.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 that creates an instance of theList.Builder
avoiding the need to create
one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and its result
is passed to #tags(List)
.tags
- a consumer that will call methods on List.Builder
#tags(List)
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.
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.
SecretListEntry.Builder owningService(String owningService)
Returns the name of the service that created the secret.
owningService
- Returns the name of the service that created the secret.SecretListEntry.Builder createdDate(Instant createdDate)
The date and time when a secret was created.
createdDate
- The date and time when a secret was created.SecretListEntry.Builder primaryRegion(String primaryRegion)
The Region where Secrets Manager originated the secret.
primaryRegion
- The Region where Secrets Manager originated the secret.