@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DescribeSecretResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable, Cloneable
Constructor and Description |
---|
DescribeSecretResult() |
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 that the secret was created.
|
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 AWS 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 most recent date and time that the Secrets Manager rotation process was successfully completed.
|
String |
getName()
The user-provided friendly name of the secret.
|
String |
getOwningService()
Returns the name of the service that created this secret.
|
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 that contains 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 that the secret was created.
|
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 AWS 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 most recent date and time that the Secrets Manager rotation process was successfully completed.
|
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 |
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 that contains 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 that the secret was created.
|
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 AWS 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 most recent date and time that the Secrets Manager rotation process was successfully completed.
|
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 |
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 that contains 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. |
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata
public void setARN(String aRN)
The ARN of the secret.
aRN
- The ARN of the secret.public String getARN()
The ARN of the secret.
public DescribeSecretResult withARN(String aRN)
The ARN of the secret.
aRN
- The ARN of the secret.public void setName(String name)
The user-provided friendly name of the secret.
name
- The user-provided friendly name of the secret.public String getName()
The user-provided friendly name of the secret.
public DescribeSecretResult withName(String name)
The user-provided friendly name of the secret.
name
- The user-provided friendly name of the secret.public void setDescription(String description)
The user-provided description of the secret.
description
- The user-provided description of the secret.public String getDescription()
The user-provided description of the secret.
public DescribeSecretResult withDescription(String description)
The user-provided description of the secret.
description
- The user-provided description of the secret.public void setKmsKeyId(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.
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.public String getKmsKeyId()
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.
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.public DescribeSecretResult withKmsKeyId(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.
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.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.
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.
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.
To enable rotation, use RotateSecret with AutomaticallyRotateAfterDays
set to a value
greater than 0. To disable rotation, use CancelRotateSecret.
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.
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.
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.
To enable rotation, use RotateSecret with AutomaticallyRotateAfterDays
set to a value
greater than 0. To disable rotation, use CancelRotateSecret.
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
.
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
.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
.
RotateSecret
.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
.
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
.public void setRotationRules(RotationRulesType rotationRules)
A structure that contains the rotation configuration for this secret.
rotationRules
- A structure that contains the rotation configuration for this secret.public RotationRulesType getRotationRules()
A structure that contains the rotation configuration for this secret.
public DescribeSecretResult withRotationRules(RotationRulesType rotationRules)
A structure that contains the rotation configuration for this secret.
rotationRules
- A structure that contains the rotation configuration for this secret.public void setLastRotatedDate(Date 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.
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.public Date getLastRotatedDate()
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.
public DescribeSecretResult withLastRotatedDate(Date 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.
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.public void setLastChangedDate(Date lastChangedDate)
The last date and time that this secret was modified in any way.
lastChangedDate
- The last date and time that this secret was modified in any way.public Date getLastChangedDate()
The last date and time that this secret was modified in any way.
public DescribeSecretResult withLastChangedDate(Date lastChangedDate)
The last date and time that this secret was modified in any way.
lastChangedDate
- The last date and time that this secret was modified in any way.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.
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.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.
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.
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.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.
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.
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.
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.
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.
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.
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.
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.
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.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.
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.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.
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.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.
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.
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.
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.
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.
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.
public DescribeSecretResult addVersionIdsToStagesEntry(String key, List<String> value)
public DescribeSecretResult clearVersionIdsToStagesEntries()
public void setOwningService(String owningService)
Returns the name of the service that created this secret.
owningService
- Returns the name of the service that created this secret.public String getOwningService()
Returns the name of the service that created this secret.
public DescribeSecretResult withOwningService(String owningService)
Returns the name of the service that created this secret.
owningService
- Returns the name of the service that created this secret.public void setCreatedDate(Date createdDate)
The date that the secret was created.
createdDate
- The date that the secret was created.public Date getCreatedDate()
The date that the secret was created.
public DescribeSecretResult withCreatedDate(Date createdDate)
The date that the secret was created.
createdDate
- The date that the secret was created.public String toString()
toString
in class Object
Object.toString()
public DescribeSecretResult clone()
Copyright © 2021. All rights reserved.