public static interface DescribeSecretResponse.Builder extends SecretsManagerResponse.Builder, SdkPojo, CopyableBuilder<DescribeSecretResponse.Builder,DescribeSecretResponse>
| Modifier and Type | Method and Description |
|---|---|
DescribeSecretResponse.Builder |
arn(String arn)
The ARN of the secret.
|
DescribeSecretResponse.Builder |
createdDate(Instant createdDate)
The date the secret was created.
|
DescribeSecretResponse.Builder |
deletedDate(Instant deletedDate)
The date the secret is scheduled for deletion.
|
DescribeSecretResponse.Builder |
description(String description)
The description of the secret.
|
DescribeSecretResponse.Builder |
kmsKeyId(String kmsKeyId)
The ARN of the KMS key that Secrets Manager uses to encrypt the secret value.
|
DescribeSecretResponse.Builder |
lastAccessedDate(Instant lastAccessedDate)
The last date that the secret value was retrieved.
|
DescribeSecretResponse.Builder |
lastChangedDate(Instant lastChangedDate)
The last date and time that this secret was modified in any way.
|
DescribeSecretResponse.Builder |
lastRotatedDate(Instant lastRotatedDate)
The last date and time that Secrets Manager rotated the secret.
|
DescribeSecretResponse.Builder |
name(String name)
The name of the secret.
|
DescribeSecretResponse.Builder |
owningService(String owningService)
The name of the service that created this secret.
|
DescribeSecretResponse.Builder |
primaryRegion(String primaryRegion)
The Region the secret is in.
|
DescribeSecretResponse.Builder |
replicationStatus(Collection<ReplicationStatusType> replicationStatus)
A list of the replicas of this secret and their status:
|
DescribeSecretResponse.Builder |
replicationStatus(Consumer<ReplicationStatusType.Builder>... replicationStatus)
A list of the replicas of this secret and their status:
|
DescribeSecretResponse.Builder |
replicationStatus(ReplicationStatusType... replicationStatus)
A list of the replicas of this secret and their status:
|
DescribeSecretResponse.Builder |
rotationEnabled(Boolean rotationEnabled)
Specifies whether automatic rotation is turned on for this secret.
|
DescribeSecretResponse.Builder |
rotationLambdaARN(String rotationLambdaARN)
The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
|
default DescribeSecretResponse.Builder |
rotationRules(Consumer<RotationRulesType.Builder> rotationRules)
The rotation schedule and Lambda function for this secret.
|
DescribeSecretResponse.Builder |
rotationRules(RotationRulesType rotationRules)
The rotation schedule and Lambda function for this secret.
|
DescribeSecretResponse.Builder |
tags(Collection<Tag> tags)
The list of tags attached to the secret.
|
DescribeSecretResponse.Builder |
tags(Consumer<Tag.Builder>... tags)
The list of tags attached to the secret.
|
DescribeSecretResponse.Builder |
tags(Tag... tags)
The list of tags attached to the secret.
|
DescribeSecretResponse.Builder |
versionIdsToStages(Map<String,? extends Collection<String>> versionIdsToStages)
A list of the versions of the secret that have staging labels attached.
|
build, responseMetadata, responseMetadatasdkHttpResponse, sdkHttpResponseequalsBySdkFields, sdkFieldscopyapplyMutation, buildDescribeSecretResponse.Builder arn(String arn)
The ARN of the secret.
arn - The ARN of the secret.DescribeSecretResponse.Builder name(String name)
The name of the secret.
name - The name of the secret.DescribeSecretResponse.Builder description(String description)
The description of the secret.
description - The description of the secret.DescribeSecretResponse.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.
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.DescribeSecretResponse.Builder rotationEnabled(Boolean rotationEnabled)
Specifies whether automatic rotation is turned on for this secret.
To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
rotationEnabled - Specifies whether automatic rotation is turned on for this secret.
To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
DescribeSecretResponse.Builder rotationLambdaARN(String rotationLambdaARN)
The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
rotationLambdaARN - The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.DescribeSecretResponse.Builder rotationRules(RotationRulesType rotationRules)
The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had rotation turned on, this field is omitted.
rotationRules - The rotation schedule and Lambda function for this secret. If the secret previously had rotation
turned on, but it is now turned off, this field shows the previous rotation schedule and rotation
function. If the secret never had rotation turned on, this field is omitted.default DescribeSecretResponse.Builder rotationRules(Consumer<RotationRulesType.Builder> rotationRules)
The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had rotation turned on, this field is omitted.
This is a convenience method 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.BuilderrotationRules(RotationRulesType)DescribeSecretResponse.Builder lastRotatedDate(Instant lastRotatedDate)
The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation, Secrets Manager returns null.
lastRotatedDate - The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for
rotation, Secrets Manager returns null.DescribeSecretResponse.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.DescribeSecretResponse.Builder lastAccessedDate(Instant lastAccessedDate)
The last date that the secret value was retrieved. This value does not include the time. This field is omitted if the secret has never been retrieved.
lastAccessedDate - The last date that the secret value was retrieved. This value does not include the time. This field is
omitted if the secret has never been retrieved.DescribeSecretResponse.Builder deletedDate(Instant deletedDate)
The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is omitted. When you delete a secret, Secrets Manager requires a recovery window of at least 7 days before deleting the secret. Some time after the deleted date, Secrets Manager deletes the secret, including all of its versions.
If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret.
deletedDate - The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is
omitted. When you delete a secret, Secrets Manager requires a recovery window of at least 7 days
before deleting the secret. Some time after the deleted date, Secrets Manager deletes the secret,
including all of its versions.
If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret.
DescribeSecretResponse.Builder tags(Collection<Tag> tags)
The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
tags - The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove
tags, use UntagResource.DescribeSecretResponse.Builder tags(Tag... tags)
The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
tags - The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove
tags, use UntagResource.DescribeSecretResponse.Builder tags(Consumer<Tag.Builder>... tags)
The list of tags attached to 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 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) DescribeSecretResponse.Builder versionIdsToStages(Map<String,? extends Collection<String>> versionIdsToStages)
A list of the versions of the secret that have staging labels attached. Versions that don't have staging labels are considered deprecated and Secrets Manager can delete them.
Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three staging labels for rotation are:
AWSCURRENT, which indicates the current version of the secret.
AWSPENDING, which indicates the version of the secret that contains new secret information that
will become the next current version when rotation finishes.
During rotation, Secrets Manager creates an AWSPENDING version ID before creating the new secret
version. To check if a secret version exists, call GetSecretValue.
AWSPREVIOUS, which indicates the previous current version of the secret. You can use this as the
last known good version.
For more information about rotation and staging labels, see How rotation works.
versionIdsToStages - A list of the versions of the secret that have staging labels attached. Versions that don't have
staging labels are considered deprecated and Secrets Manager can delete them.
Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three staging labels for rotation are:
AWSCURRENT, which indicates the current version of the secret.
AWSPENDING, which indicates the version of the secret that contains new secret
information that will become the next current version when rotation finishes.
During rotation, Secrets Manager creates an AWSPENDING version ID before creating the new
secret version. To check if a secret version exists, call GetSecretValue.
AWSPREVIOUS, which indicates the previous current version of the secret. You can use this
as the last known good version.
For more information about rotation and staging labels, see How rotation works.
DescribeSecretResponse.Builder owningService(String owningService)
The name of the service that created this secret.
owningService - The name of the service that created this secret.DescribeSecretResponse.Builder createdDate(Instant createdDate)
The date the secret was created.
createdDate - The date the secret was created.DescribeSecretResponse.Builder primaryRegion(String primaryRegion)
The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in
ReplicationStatus.
primaryRegion - The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in
ReplicationStatus.DescribeSecretResponse.Builder replicationStatus(Collection<ReplicationStatusType> replicationStatus)
A list of the replicas of this secret and their status:
Failed, which indicates that the replica was not created.
InProgress, which indicates that Secrets Manager is in the process of creating the replica.
InSync, which indicates that the replica was created.
replicationStatus - A list of the replicas of this secret and their status:
Failed, which indicates that the replica was not created.
InProgress, which indicates that Secrets Manager is in the process of creating the
replica.
InSync, which indicates that the replica was created.
DescribeSecretResponse.Builder replicationStatus(ReplicationStatusType... replicationStatus)
A list of the replicas of this secret and their status:
Failed, which indicates that the replica was not created.
InProgress, which indicates that Secrets Manager is in the process of creating the replica.
InSync, which indicates that the replica was created.
replicationStatus - A list of the replicas of this secret and their status:
Failed, which indicates that the replica was not created.
InProgress, which indicates that Secrets Manager is in the process of creating the
replica.
InSync, which indicates that the replica was created.
DescribeSecretResponse.Builder replicationStatus(Consumer<ReplicationStatusType.Builder>... replicationStatus)
A list of the replicas of this secret and their status:
Failed, which indicates that the replica was not created.
InProgress, which indicates that Secrets Manager is in the process of creating the replica.
InSync, which indicates that the replica was created.
List.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 #replicationStatus(List) .replicationStatus - a consumer that will call methods on List.Builder #replicationStatus(List) Copyright © 2022. All rights reserved.