DescribeSecretResult (AWS Java SDK for AWS Secrets Manager 1.12.187 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.secretsmanager.model.DescribeSecretResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeSecretResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeSecretResult()

Constructors
Constructor and Description
`DescribeSecretResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribeSecretResult`	`addVersionIdsToStagesEntry(String key, List<String> value)` Add a single VersionIdsToStages entry
`DescribeSecretResult`	`clearVersionIdsToStagesEntries()` Removes all the entries added into VersionIdsToStages.
`DescribeSecretResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getARN()` The ARN of the secret.
`Date`	`getCreatedDate()` The date the secret was created.
`Date`	`getDeletedDate()` The date the secret is scheduled for deletion.
`String`	`getDescription()` The description of the secret.
`String`	`getKmsKeyId()` The ARN of the KMS key that Secrets Manager uses to encrypt the secret value.
`Date`	`getLastAccessedDate()` The last date that the secret value was retrieved.
`Date`	`getLastChangedDate()` The last date and time that this secret was modified in any way.
`Date`	`getLastRotatedDate()` The last date and time that Secrets Manager rotated the secret.
`String`	`getName()` The name of the secret.
`String`	`getOwningService()` The name of the service that created this secret.
`String`	`getPrimaryRegion()` The Region the secret is in.
`List<ReplicationStatusType>`	`getReplicationStatus()` A list of the replicas of this secret and their status:
`Boolean`	`getRotationEnabled()` Specifies whether automatic rotation is turned on for this secret.
`String`	`getRotationLambdaARN()` The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
`RotationRulesType`	`getRotationRules()` The rotation schedule and Lambda function for this secret.
`List<Tag>`	`getTags()` The list of tags attached to the secret.
`Map<String,List<String>>`	`getVersionIdsToStages()` A list of the versions of the secret that have staging labels attached.
`int`	`hashCode()`
`Boolean`	`isRotationEnabled()` Specifies whether automatic rotation is turned on for this secret.
`void`	`setARN(String aRN)` The ARN of the secret.
`void`	`setCreatedDate(Date createdDate)` The date the secret was created.
`void`	`setDeletedDate(Date deletedDate)` The date the secret is scheduled for deletion.
`void`	`setDescription(String description)` The description of the secret.
`void`	`setKmsKeyId(String kmsKeyId)` The ARN of the KMS key that Secrets Manager uses to encrypt the secret value.
`void`	`setLastAccessedDate(Date lastAccessedDate)` The last date that the secret value was retrieved.
`void`	`setLastChangedDate(Date lastChangedDate)` The last date and time that this secret was modified in any way.
`void`	`setLastRotatedDate(Date lastRotatedDate)` The last date and time that Secrets Manager rotated the secret.
`void`	`setName(String name)` The name of the secret.
`void`	`setOwningService(String owningService)` The name of the service that created this secret.
`void`	`setPrimaryRegion(String primaryRegion)` The Region the secret is in.
`void`	`setReplicationStatus(Collection<ReplicationStatusType> replicationStatus)` A list of the replicas of this secret and their status:
`void`	`setRotationEnabled(Boolean rotationEnabled)` Specifies whether automatic rotation is turned on for this secret.
`void`	`setRotationLambdaARN(String rotationLambdaARN)` The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
`void`	`setRotationRules(RotationRulesType rotationRules)` The rotation schedule and Lambda function for this secret.
`void`	`setTags(Collection<Tag> tags)` The list of tags attached to the secret.
`void`	`setVersionIdsToStages(Map<String,List<String>> versionIdsToStages)` A list of the versions of the secret that have staging labels attached.
`String`	`toString()` Returns a string representation of this object.
`DescribeSecretResult`	`withARN(String aRN)` The ARN of the secret.
`DescribeSecretResult`	`withCreatedDate(Date createdDate)` The date the secret was created.
`DescribeSecretResult`	`withDeletedDate(Date deletedDate)` The date the secret is scheduled for deletion.
`DescribeSecretResult`	`withDescription(String description)` The description of the secret.
`DescribeSecretResult`	`withKmsKeyId(String kmsKeyId)` The ARN of the KMS key that Secrets Manager uses to encrypt the secret value.
`DescribeSecretResult`	`withLastAccessedDate(Date lastAccessedDate)` The last date that the secret value was retrieved.
`DescribeSecretResult`	`withLastChangedDate(Date lastChangedDate)` The last date and time that this secret was modified in any way.
`DescribeSecretResult`	`withLastRotatedDate(Date lastRotatedDate)` The last date and time that Secrets Manager rotated the secret.
`DescribeSecretResult`	`withName(String name)` The name of the secret.
`DescribeSecretResult`	`withOwningService(String owningService)` The name of the service that created this secret.
`DescribeSecretResult`	`withPrimaryRegion(String primaryRegion)` The Region the secret is in.
`DescribeSecretResult`	`withReplicationStatus(Collection<ReplicationStatusType> replicationStatus)` A list of the replicas of this secret and their status:
`DescribeSecretResult`	`withReplicationStatus(ReplicationStatusType... replicationStatus)` A list of the replicas of this secret and their status:
`DescribeSecretResult`	`withRotationEnabled(Boolean rotationEnabled)` Specifies whether automatic rotation is turned on for this secret.
`DescribeSecretResult`	`withRotationLambdaARN(String rotationLambdaARN)` The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
`DescribeSecretResult`	`withRotationRules(RotationRulesType rotationRules)` The rotation schedule and Lambda function for this secret.
`DescribeSecretResult`	`withTags(Collection<Tag> tags)` The list of tags attached to the secret.
`DescribeSecretResult`	`withTags(Tag... tags)` The list of tags attached to the secret.
`DescribeSecretResult`	`withVersionIdsToStages(Map<String,List<String>> versionIdsToStages)` A list of the versions of the secret that have staging labels attached.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DescribeSecretResult
```
public DescribeSecretResult()
```
- Method Detail
  - setARN
```
public void setARN(String aRN)
```
    The ARN of the secret.
    
    Parameters:
    
    aRN - The ARN of the secret.
  - getARN
```
public String getARN()
```
    The ARN of the secret.
    
    Returns:
    
    The ARN of the secret.
  - withARN
```
public DescribeSecretResult withARN(String aRN)
```
    The ARN of the secret.
    
    Parameters:
    
    aRN - The ARN of the secret.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the secret.
    
    Parameters:
    
    name - The name of the secret.
  - getName
```
public String getName()
```
    The name of the secret.
    
    Returns:
    
    The name of the secret.
  - withName
```
public DescribeSecretResult withName(String name)
```
    The name of the secret.
    
    Parameters:
    
    name - The name of the secret.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The description of the secret.
    
    Parameters:
    
    description - The description of the secret.
  - getDescription
```
public String getDescription()
```
    The description of the secret.
    
    Returns:
    
    The description of the secret.
  - withDescription
```
public DescribeSecretResult withDescription(String description)
```
    The description of the secret.
    
    Parameters:
    
    description - The description of the secret.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKmsKeyId
```
public void setKmsKeyId(String kmsKeyId)
```
    The 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.
    
    Parameters:
    
    kmsKeyId - The 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.
  - getKmsKeyId
```
public String getKmsKeyId()
```
    The 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.
    
    Returns:
    
    The 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.
  - withKmsKeyId
```
public DescribeSecretResult withKmsKeyId(String kmsKeyId)
```
    The 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.
    
    Parameters:
    
    kmsKeyId - The 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRotationEnabled
```
public void setRotationEnabled(Boolean rotationEnabled)
```
    Specifies whether automatic rotation is turned on for this secret.
    
    To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
    
    Parameters:
    
    rotationEnabled - Specifies whether automatic rotation is turned on for this secret.
    
    To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
  - getRotationEnabled
```
public Boolean getRotationEnabled()
```
    Specifies whether automatic rotation is turned on for this secret.
    
    To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
    
    Returns:
    
    Specifies whether automatic rotation is turned on for this secret.
    
    To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
  - withRotationEnabled
```
public DescribeSecretResult withRotationEnabled(Boolean rotationEnabled)
```
    Specifies whether automatic rotation is turned on for this secret.
    
    To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
    
    Parameters:
    
    rotationEnabled - Specifies whether automatic rotation is turned on for this secret.
    
    To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isRotationEnabled
```
public Boolean isRotationEnabled()
```
    Specifies whether automatic rotation is turned on for this secret.
    
    To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
    
    Returns:
    
    Specifies whether automatic rotation is turned on for this secret.
    
    To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
  - setRotationLambdaARN
```
public void setRotationLambdaARN(String rotationLambdaARN)
```
    The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
    
    Parameters:
    
    rotationLambdaARN - The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
  - getRotationLambdaARN
```
public String getRotationLambdaARN()
```
    The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
    
    Returns:
    
    The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
  - withRotationLambdaARN
```
public DescribeSecretResult withRotationLambdaARN(String rotationLambdaARN)
```
    The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
    
    Parameters:
    
    rotationLambdaARN - The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRotationRules
```
public void setRotationRules(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.
    
    Parameters:
    
    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.
  - getRotationRules
```
public RotationRulesType getRotationRules()
```
    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.
    
    Returns:
    
    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.
  - withRotationRules
```
public DescribeSecretResult withRotationRules(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastRotatedDate
```
public void setLastRotatedDate(Date lastRotatedDate)
```
    The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation, Secrets Manager returns null.
    
    Parameters:
    
    lastRotatedDate - The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation, Secrets Manager returns null.
  - getLastRotatedDate
```
public Date getLastRotatedDate()
```
    The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation, Secrets Manager returns null.
    
    Returns:
    
    The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation, Secrets Manager returns null.
  - withLastRotatedDate
```
public DescribeSecretResult withLastRotatedDate(Date lastRotatedDate)
```
    The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation, Secrets Manager returns null.
    
    Parameters:
    
    lastRotatedDate - The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation, Secrets Manager returns null.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastChangedDate
```
public void setLastChangedDate(Date lastChangedDate)
```
    The last date and time that this secret was modified in any way.
    
    Parameters:
    
    lastChangedDate - The last date and time that this secret was modified in any way.
  - getLastChangedDate
```
public Date getLastChangedDate()
```
    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.
  - withLastChangedDate
```
public DescribeSecretResult withLastChangedDate(Date lastChangedDate)
```
    The last date and time that this secret was modified in any way.
    
    Parameters:
    
    lastChangedDate - The last date and time that this secret was modified in any way.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastAccessedDate
```
public void setLastAccessedDate(Date lastAccessedDate)
```
    The last date that the secret value was retrieved. This value does not include the time. This field is omitted if the secret has never been retrieved.
    
    Parameters:
    
    lastAccessedDate - The last date that the secret value was retrieved. This value does not include the time. This field is omitted if the secret has never been retrieved.
  - getLastAccessedDate
```
public Date getLastAccessedDate()
```
    The last date that the secret value was retrieved. This value does not include the time. This field is omitted if the secret has never been retrieved.
    
    Returns:
    
    The last date that the secret value was retrieved. This value does not include the time. This field is omitted if the secret has never been retrieved.
  - withLastAccessedDate
```
public DescribeSecretResult withLastAccessedDate(Date lastAccessedDate)
```
    The last date that the secret value was retrieved. This value does not include the time. This field is omitted if the secret has never been retrieved.
    
    Parameters:
    
    lastAccessedDate - The last date that the secret value was retrieved. This value does not include the time. This field is omitted if the secret has never been retrieved.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDeletedDate
```
public void setDeletedDate(Date 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.
    
    Parameters:
    
    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.
  - getDeletedDate
```
public Date getDeletedDate()
```
    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.
    
    Returns:
    
    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.
  - withDeletedDate
```
public DescribeSecretResult withDeletedDate(Date 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
    
    Returns:
    
    The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
    
    Parameters:
    
    tags - The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
  - withTags
```
public DescribeSecretResult withTags(Tag... tags)
```
    The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public DescribeSecretResult withTags(Collection<Tag> tags)
```
    The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
    
    Parameters:
    
    tags - The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getVersionIdsToStages
```
public Map<String,List<String>> getVersionIdsToStages()
```
    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.
    Returns:
    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.
  - setVersionIdsToStages
```
public void setVersionIdsToStages(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.
    Parameters:
    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.
  - withVersionIdsToStages
```
public DescribeSecretResult withVersionIdsToStages(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addVersionIdsToStagesEntry
```
public DescribeSecretResult addVersionIdsToStagesEntry(String key,
                                                       List<String> value)
```
    Add a single VersionIdsToStages entry
    
    See Also:
    
    withVersionIdsToStages(java.util.Map<java.lang.String, java.util.List<java.lang.String>>)
  - clearVersionIdsToStagesEntries
```
public DescribeSecretResult clearVersionIdsToStagesEntries()
```
    Removes all the entries added into VersionIdsToStages.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOwningService
```
public void setOwningService(String owningService)
```
    The name of the service that created this secret.
    
    Parameters:
    
    owningService - The name of the service that created this secret.
  - getOwningService
```
public String getOwningService()
```
    The name of the service that created this secret.
    
    Returns:
    
    The name of the service that created this secret.
  - withOwningService
```
public DescribeSecretResult withOwningService(String owningService)
```
    The name of the service that created this secret.
    
    Parameters:
    
    owningService - The name of the service that created this secret.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedDate
```
public void setCreatedDate(Date createdDate)
```
    The date the secret was created.
    
    Parameters:
    
    createdDate - The date the secret was created.
  - getCreatedDate
```
public Date getCreatedDate()
```
    The date the secret was created.
    
    Returns:
    
    The date the secret was created.
  - withCreatedDate
```
public DescribeSecretResult withCreatedDate(Date createdDate)
```
    The date the secret was created.
    
    Parameters:
    
    createdDate - The date the secret was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPrimaryRegion
```
public void setPrimaryRegion(String primaryRegion)
```
    The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in ReplicationStatus.
    
    Parameters:
    
    primaryRegion - The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in ReplicationStatus.
  - getPrimaryRegion
```
public String getPrimaryRegion()
```
    The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in ReplicationStatus.
    
    Returns:
    
    The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in ReplicationStatus.
  - withPrimaryRegion
```
public DescribeSecretResult withPrimaryRegion(String primaryRegion)
```
    The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in ReplicationStatus.
    
    Parameters:
    
    primaryRegion - The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in ReplicationStatus.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getReplicationStatus
```
public List<ReplicationStatusType> getReplicationStatus()
```
    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.
    Returns:
    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.
  - setReplicationStatus
```
public void setReplicationStatus(Collection<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.
    Parameters:
    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.
  - withReplicationStatus
```
public DescribeSecretResult withReplicationStatus(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.
    NOTE: This method appends the values to the existing list (if any). Use setReplicationStatus(java.util.Collection) or withReplicationStatus(java.util.Collection) if you want to override the existing values.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withReplicationStatus
```
public DescribeSecretResult withReplicationStatus(Collection<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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DescribeSecretResult clone()
```
    Overrides:
    
    clone in class Object

Class DescribeSecretResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DescribeSecretResult

Method Detail

setARN

getARN

withARN

setName

getName

withName

setDescription

getDescription

withDescription

setKmsKeyId

getKmsKeyId

withKmsKeyId

setRotationEnabled

getRotationEnabled

withRotationEnabled

isRotationEnabled

setRotationLambdaARN

getRotationLambdaARN

withRotationLambdaARN

setRotationRules

getRotationRules

withRotationRules

setLastRotatedDate

getLastRotatedDate

withLastRotatedDate

setLastChangedDate

getLastChangedDate

withLastChangedDate

setLastAccessedDate

getLastAccessedDate

withLastAccessedDate

setDeletedDate

getDeletedDate

withDeletedDate

getTags

setTags

withTags

withTags

getVersionIdsToStages

setVersionIdsToStages

withVersionIdsToStages

addVersionIdsToStagesEntry

clearVersionIdsToStagesEntries

setOwningService

getOwningService

withOwningService

setCreatedDate

getCreatedDate

withCreatedDate

setPrimaryRegion

getPrimaryRegion

withPrimaryRegion

getReplicationStatus

setReplicationStatus

withReplicationStatus

withReplicationStatus

toString

equals

hashCode

clone