public static interface DescribeSecretResponse.Builder extends SecretsManagerResponse.Builder, CopyableBuilder<DescribeSecretResponse.Builder,DescribeSecretResponse>
Modifier and Type | Method and Description |
---|---|
DescribeSecretResponse.Builder |
arn(String arn)
The ARN of the secret.
|
DescribeSecretResponse.Builder |
deletedDate(Instant deletedDate)
This value exists if the secret is scheduled for deletion.
|
DescribeSecretResponse.Builder |
description(String description)
The user-provided description of the secret.
|
DescribeSecretResponse.Builder |
kmsKeyId(String kmsKeyId)
The ARN or alias of the AWS KMS customer master key (CMK) that's used to encrypt the
SecretString or SecretBinary fields in each version of the secret. |
DescribeSecretResponse.Builder |
lastAccessedDate(Instant lastAccessedDate)
The last date that this secret was accessed.
|
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 the Secrets Manager rotation process for this secret was invoked.
|
DescribeSecretResponse.Builder |
name(String name)
The user-provided friendly name of the secret.
|
DescribeSecretResponse.Builder |
rotationEnabled(Boolean rotationEnabled)
Specifies whether automatic rotation is enabled for this secret.
|
DescribeSecretResponse.Builder |
rotationLambdaARN(String rotationLambdaARN)
The ARN of a Lambda function that's invoked by Secrets Manager to rotate the secret either automatically per
the schedule or manually by a call to
RotateSecret . |
default DescribeSecretResponse.Builder |
rotationRules(Consumer<RotationRulesType.Builder> rotationRules)
A structure that contains the rotation configuration for this secret.
|
DescribeSecretResponse.Builder |
rotationRules(RotationRulesType rotationRules)
A structure that contains the rotation configuration for this secret.
|
DescribeSecretResponse.Builder |
tags(Collection<Tag> tags)
The list of user-defined tags that are associated with the secret.
|
DescribeSecretResponse.Builder |
tags(Consumer<Tag.Builder>... tags)
The list of user-defined tags that are associated with the secret.
|
DescribeSecretResponse.Builder |
tags(Tag... tags)
The list of user-defined tags that are associated with the secret.
|
DescribeSecretResponse.Builder |
versionIdsToStages(Map<String,? extends Collection<String>> versionIdsToStages)
A list of all of the currently assigned
VersionStage staging labels and the
SecretVersionId that each is attached to. |
build
sdkHttpResponse, sdkHttpResponse
copy
applyMutation, build
DescribeSecretResponse.Builder arn(String arn)
The ARN of the secret.
arn
- The ARN of the secret.DescribeSecretResponse.Builder name(String name)
The user-provided friendly name of the secret.
name
- The user-provided friendly name of the secret.DescribeSecretResponse.Builder description(String description)
The user-provided description of the secret.
description
- The user-provided description of the secret.DescribeSecretResponse.Builder kmsKeyId(String kmsKeyId)
The ARN or alias of the AWS KMS customer master key (CMK) that's used to encrypt the
SecretString
or 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
one named awssecretsmanager
) for this account.
kmsKeyId
- The ARN or alias of the AWS KMS customer master key (CMK) that's used to encrypt the
SecretString
or 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 one named awssecretsmanager
) for this account.DescribeSecretResponse.Builder rotationEnabled(Boolean rotationEnabled)
Specifies whether automatic rotation is enabled for this secret.
To enable rotation, use RotateSecret with AutomaticallyRotateAfterDays
set to a value
greater than 0. To disable rotation, use CancelRotateSecret.
rotationEnabled
- Specifies whether automatic rotation is enabled for this secret.
To enable rotation, use RotateSecret with AutomaticallyRotateAfterDays
set to a
value greater than 0. To disable rotation, use CancelRotateSecret.
DescribeSecretResponse.Builder rotationLambdaARN(String rotationLambdaARN)
The ARN of a Lambda function that's invoked by Secrets Manager to rotate the secret either automatically per
the schedule or manually by a call to RotateSecret
.
rotationLambdaARN
- The ARN of a Lambda function that's invoked by Secrets Manager to rotate the secret either
automatically per the schedule or manually by a call to RotateSecret
.DescribeSecretResponse.Builder rotationRules(RotationRulesType rotationRules)
A structure that contains the rotation configuration for this secret.
rotationRules
- A structure that contains the rotation configuration for this secret.default DescribeSecretResponse.Builder rotationRules(Consumer<RotationRulesType.Builder> rotationRules)
A structure that contains the rotation configuration for this 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)
DescribeSecretResponse.Builder lastRotatedDate(Instant lastRotatedDate)
The last date and time that the Secrets Manager rotation process for this secret was invoked.
lastRotatedDate
- The last date and time that the Secrets Manager rotation process for this secret was invoked.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 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.DescribeSecretResponse.Builder deletedDate(Instant deletedDate)
This value exists if the secret is scheduled for deletion. Some time after the specified date and time, Secrets Manager deletes the secret and all of its versions.
If a secret is scheduled for deletion, then its details, including the encrypted secret information, is not accessible. To cancel a scheduled deletion and restore access, use RestoreSecret.
deletedDate
- This value exists if the secret is scheduled for deletion. Some time after the specified date and
time, Secrets Manager deletes the secret and all of its versions.
If a secret is scheduled for deletion, then its details, including the encrypted secret information, is not accessible. To cancel a scheduled deletion and restore access, use RestoreSecret.
DescribeSecretResponse.Builder tags(Collection<Tag> tags)
The list of user-defined tags that are associated with the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
tags
- The list of user-defined tags that are associated with the secret. To add tags to a secret, use
TagResource. To remove tags, use UntagResource.DescribeSecretResponse.Builder tags(Tag... tags)
The list of user-defined tags that are associated with the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
tags
- The list of user-defined tags that are associated with 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 user-defined tags that are 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)
DescribeSecretResponse.Builder versionIdsToStages(Map<String,? extends Collection<String>> versionIdsToStages)
A list of all of the currently assigned VersionStage
staging labels and the
SecretVersionId
that each is attached to. Staging labels are used to keep track of the different
versions during the rotation process.
A version that does not have any staging labels attached is considered deprecated and subject to deletion. Such versions are not included in this list.
versionIdsToStages
- A list of all of the currently assigned VersionStage
staging labels and the
SecretVersionId
that each is attached to. Staging labels are used to keep track of the
different versions during the rotation process. A version that does not have any staging labels attached is considered deprecated and subject to deletion. Such versions are not included in this list.
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.