DescribeSecretResult (AWS SDK for Java

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 you created the secret.
`Date`	`getDeletedDate()` This value exists if the secret is scheduled for deletion.
`String`	`getDescription()` The user-provided description of the secret.
`String`	`getKmsKeyId()` 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.
`Date`	`getLastAccessedDate()` The last date that this secret was accessed.
`Date`	`getLastChangedDate()` The last date and time that this secret was modified in any way.
`Date`	`getLastRotatedDate()` The last date and time that the rotation process for this secret was invoked.
`String`	`getName()` The user-provided friendly name of the secret.
`String`	`getOwningService()` Returns the name of the service that created this secret.
`String`	`getPrimaryRegion()` Specifies the primary region for secret replication.
`List<ReplicationStatusType>`	`getReplicationStatus()` Describes a list of replication status objects as `InProgress`, `Failed` or `InSync`.`P`
`Boolean`	`getRotationEnabled()` Specifies whether automatic rotation is enabled for this secret.
`String`	`getRotationLambdaARN()` 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`	`getRotationRules()` A structure with the rotation configuration for this secret.
`List<Tag>`	`getTags()` The list of user-defined tags that are associated with the secret.
`Map<String,List<String>>`	`getVersionIdsToStages()` A list of all of the currently assigned `VersionStage` staging labels and the `VersionId` that each is attached to.
`int`	`hashCode()`
`Boolean`	`isRotationEnabled()` Specifies whether automatic rotation is enabled for this secret.
`void`	`setARN(String aRN)` The ARN of the secret.
`void`	`setCreatedDate(Date createdDate)` The date you created the secret.
`void`	`setDeletedDate(Date deletedDate)` This value exists if the secret is scheduled for deletion.
`void`	`setDescription(String description)` The user-provided description of the secret.
`void`	`setKmsKeyId(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.
`void`	`setLastAccessedDate(Date lastAccessedDate)` The last date that this secret was accessed.
`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 the rotation process for this secret was invoked.
`void`	`setName(String name)` The user-provided friendly name of the secret.
`void`	`setOwningService(String owningService)` Returns the name of the service that created this secret.
`void`	`setPrimaryRegion(String primaryRegion)` Specifies the primary region for secret replication.
`void`	`setReplicationStatus(Collection<ReplicationStatusType> replicationStatus)` Describes a list of replication status objects as `InProgress`, `Failed` or `InSync`.`P`
`void`	`setRotationEnabled(Boolean rotationEnabled)` Specifies whether automatic rotation is enabled for this secret.
`void`	`setRotationLambdaARN(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`.
`void`	`setRotationRules(RotationRulesType rotationRules)` A structure with the rotation configuration for this secret.
`void`	`setTags(Collection<Tag> tags)` The list of user-defined tags that are associated with the secret.
`void`	`setVersionIdsToStages(Map<String,List<String>> versionIdsToStages)` A list of all of the currently assigned `VersionStage` staging labels and the `VersionId` that each is attached to.
`String`	`toString()` Returns a string representation of this object.
`DescribeSecretResult`	`withARN(String aRN)` The ARN of the secret.
`DescribeSecretResult`	`withCreatedDate(Date createdDate)` The date you created the secret.
`DescribeSecretResult`	`withDeletedDate(Date deletedDate)` This value exists if the secret is scheduled for deletion.
`DescribeSecretResult`	`withDescription(String description)` The user-provided description of the secret.
`DescribeSecretResult`	`withKmsKeyId(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.
`DescribeSecretResult`	`withLastAccessedDate(Date lastAccessedDate)` The last date that this secret was accessed.
`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 the rotation process for this secret was invoked.
`DescribeSecretResult`	`withName(String name)` The user-provided friendly name of the secret.
`DescribeSecretResult`	`withOwningService(String owningService)` Returns the name of the service that created this secret.
`DescribeSecretResult`	`withPrimaryRegion(String primaryRegion)` Specifies the primary region for secret replication.
`DescribeSecretResult`	`withReplicationStatus(Collection<ReplicationStatusType> replicationStatus)` Describes a list of replication status objects as `InProgress`, `Failed` or `InSync`.`P`
`DescribeSecretResult`	`withReplicationStatus(ReplicationStatusType... replicationStatus)` Describes a list of replication status objects as `InProgress`, `Failed` or `InSync`.`P`
`DescribeSecretResult`	`withRotationEnabled(Boolean rotationEnabled)` Specifies whether automatic rotation is enabled for this secret.
`DescribeSecretResult`	`withRotationLambdaARN(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`.
`DescribeSecretResult`	`withRotationRules(RotationRulesType rotationRules)` A structure with the rotation configuration for this secret.
`DescribeSecretResult`	`withTags(Collection<Tag> tags)` The list of user-defined tags that are associated with the secret.
`DescribeSecretResult`	`withTags(Tag... tags)` The list of user-defined tags that are associated with the secret.
`DescribeSecretResult`	`withVersionIdsToStages(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 com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
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 user-provided friendly name of the secret.
    
    Parameters:
    
    name - The user-provided friendly name of the secret.
  - getName
```
public String getName()
```
    The user-provided friendly name of the secret.
    
    Returns:
    
    The user-provided friendly name of the secret.
  - withName
```
public DescribeSecretResult withName(String name)
```
    The user-provided friendly name of the secret.
    
    Parameters:
    
    name - The user-provided friendly 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 user-provided description of the secret.
    
    Parameters:
    
    description - The user-provided description of the secret.
  - getDescription
```
public String getDescription()
```
    The user-provided description of the secret.
    
    Returns:
    
    The user-provided description of the secret.
  - withDescription
```
public DescribeSecretResult withDescription(String description)
```
    The user-provided description of the secret.
    
    Parameters:
    
    description - The user-provided 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 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.
    
    Parameters:
    
    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.
  - getKmsKeyId
```
public String getKmsKeyId()
```
    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.
  - withKmsKeyId
```
public DescribeSecretResult withKmsKeyId(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.
    
    Parameters:
    
    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:
    
    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 enabled for this secret.
    
    To enable rotation, use RotateSecret with AutomaticallyRotateAfterDays set to a value greater than 0. To disable rotation, use CancelRotateSecret.
    
    Parameters:
    
    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.
  - getRotationEnabled
```
public Boolean getRotationEnabled()
```
    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.
  - withRotationEnabled
```
public DescribeSecretResult withRotationEnabled(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - isRotationEnabled
```
public Boolean isRotationEnabled()
```
    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.
  - setRotationLambdaARN
```
public void setRotationLambdaARN(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.
    
    Parameters:
    
    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.
  - getRotationLambdaARN
```
public String getRotationLambdaARN()
```
    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.
  - withRotationLambdaARN
```
public DescribeSecretResult withRotationLambdaARN(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRotationRules
```
public void setRotationRules(RotationRulesType rotationRules)
```
    A structure with the rotation configuration for this secret. This field is only populated if rotation is configured.
    
    Parameters:
    
    rotationRules - A structure with the rotation configuration for this secret. This field is only populated if rotation is configured.
  - getRotationRules
```
public RotationRulesType getRotationRules()
```
    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.
  - withRotationRules
```
public DescribeSecretResult withRotationRules(RotationRulesType rotationRules)
```
    A structure with the rotation configuration for this secret. This field is only populated if rotation is configured.
    
    Parameters:
    
    rotationRules - A structure with the rotation configuration for this secret. This field is only populated if rotation is configured.
    
    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 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.
    
    Parameters:
    
    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.
  - getLastRotatedDate
```
public Date getLastRotatedDate()
```
    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.
  - withLastRotatedDate
```
public DescribeSecretResult withLastRotatedDate(Date 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.
    
    Parameters:
    
    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:
    
    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 this secret was accessed. This value is truncated to midnight of the date and therefore shows only the date, not the time.
    
    Parameters:
    
    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.
  - getLastAccessedDate
```
public Date getLastAccessedDate()
```
    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.
  - withLastAccessedDate
```
public DescribeSecretResult withLastAccessedDate(Date 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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDeletedDate
```
public void setDeletedDate(Date 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.
    
    Parameters:
    
    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.
  - getDeletedDate
```
public Date getDeletedDate()
```
    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.
  - withDeletedDate
```
public DescribeSecretResult withDeletedDate(Date 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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    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.
    
    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.
  - setTags
```
public void setTags(Collection<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.
    
    Parameters:
    
    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.
  - withTags
```
public DescribeSecretResult withTags(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.
    
    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 user-defined tags that are associated with 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 user-defined tags that are associated with the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
    
    Parameters:
    
    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.
    
    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 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.
    
    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.
  - setVersionIdsToStages
```
public void setVersionIdsToStages(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.
    
    Parameters:
    
    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.
  - withVersionIdsToStages
```
public DescribeSecretResult withVersionIdsToStages(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.
    
    Parameters:
    
    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.
    
    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)
```
    Returns the name of the service that created this secret.
    
    Parameters:
    
    owningService - Returns the name of the service that created this secret.
  - getOwningService
```
public String getOwningService()
```
    Returns the name of the service that created this secret.
    
    Returns:
    
    Returns the name of the service that created this secret.
  - withOwningService
```
public DescribeSecretResult withOwningService(String owningService)
```
    Returns the name of the service that created this secret.
    
    Parameters:
    
    owningService - Returns 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 you created the secret.
    
    Parameters:
    
    createdDate - The date you created the secret.
  - getCreatedDate
```
public Date getCreatedDate()
```
    The date you created the secret.
    
    Returns:
    
    The date you created the secret.
  - withCreatedDate
```
public DescribeSecretResult withCreatedDate(Date createdDate)
```
    The date you created the secret.
    
    Parameters:
    
    createdDate - The date you created the secret.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPrimaryRegion
```
public void setPrimaryRegion(String primaryRegion)
```
    Specifies the primary region for secret replication.
    
    Parameters:
    
    primaryRegion - Specifies the primary region for secret replication.
  - getPrimaryRegion
```
public String getPrimaryRegion()
```
    Specifies the primary region for secret replication.
    
    Returns:
    
    Specifies the primary region for secret replication.
  - withPrimaryRegion
```
public DescribeSecretResult withPrimaryRegion(String primaryRegion)
```
    Specifies the primary region for secret replication.
    
    Parameters:
    
    primaryRegion - Specifies the primary region for secret replication.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getReplicationStatus
```
public List<ReplicationStatusType> getReplicationStatus()
```
    Describes a list of replication status objects as InProgress, Failed or InSync.P
    
    Returns:
    
    Describes a list of replication status objects as InProgress, Failed or InSync.P
  - setReplicationStatus
```
public void setReplicationStatus(Collection<ReplicationStatusType> replicationStatus)
```
    Describes a list of replication status objects as InProgress, Failed or InSync.P
    
    Parameters:
    
    replicationStatus - Describes a list of replication status objects as InProgress, Failed or InSync.P
  - withReplicationStatus
```
public DescribeSecretResult withReplicationStatus(ReplicationStatusType... replicationStatus)
```
    Describes a list of replication status objects as InProgress, Failed or InSync.P
    
    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 - Describes a list of replication status objects as InProgress, Failed or InSync.P
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withReplicationStatus
```
public DescribeSecretResult withReplicationStatus(Collection<ReplicationStatusType> replicationStatus)
```
    Describes a list of replication status objects as InProgress, Failed or InSync.P
    
    Parameters:
    
    replicationStatus - Describes a list of replication status objects as InProgress, Failed or InSync.P
    
    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

Did this page help you?

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