SdkPojo, ToCopyableBuilder<DescribeSecretResponse.Builder,DescribeSecretResponse> final Stringarn()builder()final Instantfinal Instantfinal Stringfinal booleanfinal booleanequalsBySdkFields(Object obj) final <T> Optional<T> getValueForField(String fieldName,
Class<T> clazz) SdkResponse.final inthashCode()final booleanfinal booleanhasTags()final booleanfinal StringkmsKeyId()final Instantfinal Instantfinal Instantfinal Stringname()final Instantfinal Stringfinal Stringfinal List<ReplicationStatusType> final Booleanfinal Stringfinal RotationRulesTypestatic Class<? extends DescribeSecretResponse.Builder> tags()final StringtoString()responseMetadatasdkHttpResponsecopyThe description of the secret.
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.Specifies whether automatic rotation is turned on for this secret. If the secret has never been configured for rotation, Secrets Manager returns null.
To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
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.
The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation or rotation has been disabled, Secrets Manager returns null.
The last date and time that this secret was modified in any way.
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.
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.
The next rotation is scheduled to occur on or before this date. If the secret isn't configured for rotation or rotation has been disabled, Secrets Manager returns null. If rotation fails, Secrets Manager retries the entire rotation process multiple times. If rotation is unsuccessful, this date may be in the past.
This date represents the latest date that rotation will occur, but it is not an approximate rotation date. In some cases, for example if you turn off automatic rotation and then turn it back on, the next rotation may occur much sooner than this date.
This date represents the latest date that rotation will occur, but it is not an approximate rotation date. In some cases, for example if you turn off automatic rotation and then turn it back on, the next rotation may occur much sooner than this date.
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.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.
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.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.
The ID of the service that created this secret. For more information, see Secrets managed by other Amazon Web Services services.
The date the secret was created.
The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in
ReplicationStatus.
ReplicationStatus.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.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.
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<DescribeSecretResponse.Builder,DescribeSecretResponse> toBuilder in class AwsResponsehashCode in class AwsResponseequals in class AwsResponseSdkPojoSdkPojo class,
and is generated based on a service model.
If an SdkPojo class does not have any inherited fields, equalsBySdkFields
and equals are essentially the same.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withSdkResponseSdkResponse. 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 SdkResponsefieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.sdkFieldNameToField in interface SdkPojo