software.amazon.awssdk.services.secretsmanager.model

Class DescribeSecretResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.secretsmanager.model.SecretsManagerResponse

software.amazon.awssdk.services.secretsmanager.model.DescribeSecretResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeSecretResponse.Builder,DescribeSecretResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeSecretResponse
extends SecretsManagerResponse
implements ToCopyableBuilder<DescribeSecretResponse.Builder,DescribeSecretResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeSecretResponse.Builder

Method Summary

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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
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 most recent date and time that the Secrets Manager rotation process was successfully completed.
String	name() The user-provided friendly name of the secret.
String	owningService() Returns the value of the OwningService property for this object.
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.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeSecretResponse.Builder>	serializableBuilderClass()
List<Tag>	tags() The list of user-defined tags that are associated with the secret.
DescribeSecretResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Map<String,List<String>>	versionIdsToStages() A list of all of the currently assigned VersionStage staging labels and the VersionId that each is attached to.

Methods inherited from class software.amazon.awssdk.services.secretsmanager.model.SecretsManagerResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

arn

public String arn()

The ARN of the secret.

Returns:

The ARN of the secret.

name

public String name()

The user-provided friendly name of the secret.

Returns:

The user-provided friendly name of the secret.

description

public String description()

The user-provided description of the secret.

Returns:

The user-provided description of the secret.

kmsKeyId

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 AWS KMS CMK (the one named awssecretsmanager) for this account.

Returns:

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 AWS KMS CMK (the one named awssecretsmanager) for this account.

rotationEnabled

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.

Returns:

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.

rotationLambdaARN

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.

Returns:

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.

rotationRules

public RotationRulesType rotationRules()

A structure that contains the rotation configuration for this secret.

Returns:

A structure that contains the rotation configuration for this secret.

lastRotatedDate

public Instant lastRotatedDate()

The most recent date and time that the Secrets Manager rotation process was successfully completed. This value is null if the secret has never rotated.

Returns:

The most recent date and time that the Secrets Manager rotation process was successfully completed. This value is null if the secret has never rotated.

lastChangedDate

public Instant lastChangedDate()

The last date and time that this secret was modified in any way.

Returns:

The last date and time that this secret was modified in any way.

lastAccessedDate

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.

Returns:

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.

deletedDate

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.

Returns:

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.

tags

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.

Returns:

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.

versionIdsToStages

public Map<String,List<String>> versionIdsToStages()

A list of all of the currently assigned VersionStage staging labels and the VersionId 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.

Returns:

A list of all of the currently assigned VersionStage staging labels and the VersionId 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.

owningService

public String owningService()

Returns the value of the OwningService property for this object.

Returns:

The value of the OwningService property for this object.

toBuilder

public DescribeSecretResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeSecretResponse.Builder,DescribeSecretResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DescribeSecretResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeSecretResponse.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo