DescribeSecretResponse (AWS Java SDK :: Services :: AWS Secrets Manager 2.17.82 API)

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DescribeSecretResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`arn()` The ARN of the secret.
`static DescribeSecretResponse.Builder`	`builder()`
`Instant`	`createdDate()` The date you created the secret.
`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()`
`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 ARN or alias of the Amazon Web Services 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 rotation process for this secret was invoked.
`String`	`name()` The user-provided friendly name of the secret.
`String`	`owningService()` Returns the name of the service that created this secret.
`String`	`primaryRegion()` Specifies the primary region for secret replication.
`List<ReplicationStatusType>`	`replicationStatus()` Describes a list of replication status objects as `InProgress`, `Failed` or `InSync`.`P`
`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 with 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 final String arn()
```
    The ARN of the secret.
    
    Returns:
    
    The ARN of the secret.
  - name
```
public final String name()
```
    The user-provided friendly name of the secret.
    
    Returns:
    
    The user-provided friendly name of the secret.
  - description
```
public final String description()
```
    The user-provided description of the secret.
    
    Returns:
    
    The user-provided description of the secret.
  - kmsKeyId
```
public final String kmsKeyId()
```
    The ARN or alias of the Amazon Web Services 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 Amazon Web Services KMS CMK (the one named awssecretsmanager) for this account.
    
    Returns:
    
    The ARN or alias of the Amazon Web Services 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 Amazon Web Services KMS CMK (the one named awssecretsmanager) for this account.
  - rotationEnabled
```
public final 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 final 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 final RotationRulesType rotationRules()
```
    A structure with the rotation configuration for this secret. This field is only populated if rotation is configured.
    
    Returns:
    
    A structure with the rotation configuration for this secret. This field is only populated if rotation is configured.
  - lastRotatedDate
```
public final Instant lastRotatedDate()
```
    The last date and time that the rotation process for this secret was invoked.
    
    The most recent date and time that the Secrets Manager rotation process successfully completed. If the secret doesn't rotate, Secrets Manager returns a null value.
    
    Returns:
    
    The last date and time that the rotation process for this secret was invoked.
    
    The most recent date and time that the Secrets Manager rotation process successfully completed. If the secret doesn't rotate, Secrets Manager returns a null value.
  - lastChangedDate
```
public final 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 final 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 final 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.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - tags
```
public final 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.
    
    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.
    
    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.
  - hasVersionIdsToStages
```
public final boolean hasVersionIdsToStages()
```
    For responses, this returns true if the service returned a value for the VersionIdsToStages property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - versionIdsToStages
```
public final 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.
    
    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.
    
    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 final String owningService()
```
    Returns the name of the service that created this secret.
    
    Returns:
    
    Returns the name of the service that created this secret.
  - createdDate
```
public final Instant createdDate()
```
    The date you created the secret.
    
    Returns:
    
    The date you created the secret.
  - primaryRegion
```
public final String primaryRegion()
```
    Specifies the primary region for secret replication.
    
    Returns:
    
    Specifies the primary region for secret replication.
  - hasReplicationStatus
```
public final boolean hasReplicationStatus()
```
    For responses, this returns true if the service returned a value for the ReplicationStatus property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - replicationStatus
```
public final List<ReplicationStatusType> replicationStatus()
```
    Describes a list of replication status objects as InProgress, Failed or InSync.P
    
    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.
    
    Returns:
    
    Describes a list of replication status objects as InProgress, Failed or InSync.P
  - 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 final int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeSecretResponse

Nested Class Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Method Detail

arn

name

description

kmsKeyId

rotationEnabled

rotationLambdaARN

rotationRules

lastRotatedDate

lastChangedDate

lastAccessedDate

deletedDate

hasTags

tags

hasVersionIdsToStages

versionIdsToStages

owningService

createdDate

primaryRegion

hasReplicationStatus

replicationStatus

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields