@Generated(value="software.amazon.awssdk:codegen") public final class DescribeSecretResponse extends SecretsManagerResponse implements ToCopyableBuilder<DescribeSecretResponse.Builder,DescribeSecretResponse>
Modifier and Type | Class and Description |
---|---|
static interface |
DescribeSecretResponse.Builder |
Modifier and Type | Method and Description |
---|---|
String |
arn()
The ARN of the secret.
|
static DescribeSecretResponse.Builder |
builder() |
Instant |
deletedDate()
This value exists if the secret is scheduled for deletion.
|
String |
description()
The user-provided description of the secret.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkResponse . |
int |
hashCode() |
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. |
Instant |
lastAccessedDate()
The last date that this secret was accessed.
|
Instant |
lastChangedDate()
The last date and time that this secret was modified in any way.
|
Instant |
lastRotatedDate()
The last date and time that the Secrets Manager rotation process for this secret was invoked.
|
String |
name()
The user-provided friendly name of the secret.
|
Boolean |
rotationEnabled()
Specifies whether automatic rotation is enabled for this secret.
|
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 . |
RotationRulesType |
rotationRules()
A structure that contains the rotation configuration for this secret.
|
static Class<? extends DescribeSecretResponse.Builder> |
serializableBuilderClass() |
List<Tag> |
tags()
The list of user-defined tags that are associated with the secret.
|
DescribeSecretResponse.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
Map<String,List<String>> |
versionIdsToStages()
A list of all of the currently assigned
VersionStage staging labels and the
SecretVersionId that each is attached to. |
sdkHttpResponse
copy
public String arn()
The ARN of the secret.
public String name()
The user-provided friendly name of the secret.
public String description()
The user-provided description of the secret.
public 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.
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.public 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.
To enable rotation, use RotateSecret with AutomaticallyRotateAfterDays
set to a value
greater than 0. To disable rotation, use CancelRotateSecret.
public 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
.
RotateSecret
.public RotationRulesType rotationRules()
A structure that contains the rotation configuration for this secret.
public Instant lastRotatedDate()
The last date and time that the Secrets Manager rotation process for this secret was invoked.
public Instant lastChangedDate()
The last date and time that this secret was modified in any way.
public 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.
public 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.
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.
public List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public Map<String,List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
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.
public DescribeSecretResponse.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DescribeSecretResponse.Builder,DescribeSecretResponse>
toBuilder
in class AwsResponse
public static DescribeSecretResponse.Builder builder()
public static Class<? extends DescribeSecretResponse.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponse
SdkResponse
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkResponse
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.