@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 |
createdDate()
The date the secret was created.
|
Instant |
deletedDate()
The date the secret is scheduled for deletion.
|
String |
description()
The description of the secret.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasReplicationStatus()
For responses, this returns true if the service returned a value for the ReplicationStatus property.
|
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
boolean |
hasVersionIdsToStages()
For responses, this returns true if the service returned a value for the VersionIdsToStages property.
|
String |
kmsKeyId()
The key ID or alias ARN of the KMS key that Secrets Manager uses to encrypt the secret value.
|
Instant |
lastAccessedDate()
The date that the secret was last accessed in the Region.
|
Instant |
lastChangedDate()
The last date and time that this secret was modified in any way.
|
Instant |
lastRotatedDate()
The last date and time that Secrets Manager rotated the secret.
|
String |
name()
The name of the secret.
|
Instant |
nextRotationDate()
The next rotation is scheduled to occur on or before this date.
|
String |
owningService()
The ID of the service that created this secret.
|
String |
primaryRegion()
The Region the secret is in.
|
List<ReplicationStatusType> |
replicationStatus()
A list of the replicas of this secret and their status:
|
Boolean |
rotationEnabled()
Specifies whether automatic rotation is turned on for this secret.
|
String |
rotationLambdaARN()
The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
|
RotationRulesType |
rotationRules()
The rotation schedule and Lambda function for this secret.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends DescribeSecretResponse.Builder> |
serializableBuilderClass() |
List<Tag> |
tags()
The list of tags attached to the secret.
|
DescribeSecretResponse.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
Map<String,List<String>> |
versionIdsToStages()
A list of the versions of the secret that have staging labels attached.
|
responseMetadatasdkHttpResponseclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String arn()
The ARN of the secret.
public final String name()
The name of the secret.
public final String description()
The description of the secret.
public final String kmsKeyId()
The key ID or alias 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.
Secrets created using the console use an KMS key ID.
aws/secretsmanager, this field
is omitted. Secrets created using the console use an KMS key ID.public final Boolean rotationEnabled()
Specifies whether automatic rotation is turned on for this secret.
To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
public final String rotationLambdaARN()
The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
public final 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.
public final 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.
public final Instant lastChangedDate()
The last date and time that this secret was modified in any way.
public final 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.
public final 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.
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.
public final Instant nextRotationDate()
The next rotation is scheduled to occur on or before this date. If the secret isn't configured for rotation, Secrets Manager returns null.
public final boolean hasTags()
isEmpty() method on the property). This is useful
because the SDK will never return a null collection or map, but you may need to differentiate between the service
returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
if a value for the property was specified in the request builder, and false if a value was not specified.public final List<Tag> tags()
The list of tags attached to 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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTags() method.
public final boolean hasVersionIdsToStages()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final Map<String,List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasVersionIdsToStages() method.
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.
public final String owningService()
The ID of the service that created this secret. For more information, see Secrets managed by other Amazon Web Services services.
public final Instant createdDate()
The date the secret was created.
public final String primaryRegion()
The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in
ReplicationStatus.
ReplicationStatus.public final boolean hasReplicationStatus()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasReplicationStatus() method.
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.
public DescribeSecretResponse.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<DescribeSecretResponse.Builder,DescribeSecretResponse>toBuilder in class AwsResponsepublic static DescribeSecretResponse.Builder builder()
public static Class<? extends DescribeSecretResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsResponsepublic final boolean equals(Object obj)
equals in class AwsResponsepublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkResponseCopyright © 2023. All rights reserved.