@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class SecretListEntry extends Object implements Serializable, Cloneable, StructuredPojo
A structure that contains the details about a secret. It does not include the encrypted SecretString
and
SecretBinary
values. To get those values, use GetSecretValue .
Constructor and Description |
---|
SecretListEntry() |
Modifier and Type | Method and Description |
---|---|
SecretListEntry |
addSecretVersionsToStagesEntry(String key,
List<String> value)
Add a single SecretVersionsToStages entry
|
SecretListEntry |
clearSecretVersionsToStagesEntries()
Removes all the entries added into SecretVersionsToStages.
|
SecretListEntry |
clone() |
boolean |
equals(Object obj) |
String |
getARN()
The Amazon Resource Name (ARN) of the secret.
|
Date |
getCreatedDate()
The date and time when a secret was created.
|
Date |
getDeletedDate()
The date and time the deletion of the secret occurred.
|
String |
getDescription()
The user-provided description of the secret.
|
String |
getKmsKeyId()
The ARN of the KMS key that Secrets Manager uses to encrypt the secret value.
|
Date |
getLastAccessedDate()
The date that the secret was last accessed in the Region.
|
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 friendly name of the secret.
|
Date |
getNextRotationDate()
The next rotation is scheduled to occur on or before this date.
|
String |
getOwningService()
Returns the name of the service that created the secret.
|
String |
getPrimaryRegion()
The Region where Secrets Manager originated the secret.
|
Boolean |
getRotationEnabled()
Indicates whether automatic, scheduled rotation is enabled for this secret.
|
String |
getRotationLambdaARN()
The ARN of an Amazon Web Services Lambda function invoked by Secrets Manager to rotate and expire the secret
either automatically per the schedule or manually by a call to
RotateSecret . |
RotationRulesType |
getRotationRules()
A structure that defines the rotation configuration for the secret.
|
Map<String,List<String>> |
getSecretVersionsToStages()
A list of all of the currently assigned
SecretVersionStage staging labels and the
SecretVersionId attached to each one. |
List<Tag> |
getTags()
The list of user-defined tags associated with the secret.
|
int |
hashCode() |
Boolean |
isRotationEnabled()
Indicates whether automatic, scheduled rotation is enabled for this secret.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setARN(String aRN)
The Amazon Resource Name (ARN) of the secret.
|
void |
setCreatedDate(Date createdDate)
The date and time when a secret was created.
|
void |
setDeletedDate(Date deletedDate)
The date and time the deletion of the secret occurred.
|
void |
setDescription(String description)
The user-provided 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 date that the secret was last accessed in the Region.
|
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 friendly name of the secret.
|
void |
setNextRotationDate(Date nextRotationDate)
The next rotation is scheduled to occur on or before this date.
|
void |
setOwningService(String owningService)
Returns the name of the service that created the secret.
|
void |
setPrimaryRegion(String primaryRegion)
The Region where Secrets Manager originated the secret.
|
void |
setRotationEnabled(Boolean rotationEnabled)
Indicates whether automatic, scheduled rotation is enabled for this secret.
|
void |
setRotationLambdaARN(String rotationLambdaARN)
The ARN of an Amazon Web Services Lambda function invoked by Secrets Manager to rotate and expire the secret
either automatically per the schedule or manually by a call to
RotateSecret . |
void |
setRotationRules(RotationRulesType rotationRules)
A structure that defines the rotation configuration for the secret.
|
void |
setSecretVersionsToStages(Map<String,List<String>> secretVersionsToStages)
A list of all of the currently assigned
SecretVersionStage staging labels and the
SecretVersionId attached to each one. |
void |
setTags(Collection<Tag> tags)
The list of user-defined tags associated with the secret.
|
String |
toString()
Returns a string representation of this object.
|
SecretListEntry |
withARN(String aRN)
The Amazon Resource Name (ARN) of the secret.
|
SecretListEntry |
withCreatedDate(Date createdDate)
The date and time when a secret was created.
|
SecretListEntry |
withDeletedDate(Date deletedDate)
The date and time the deletion of the secret occurred.
|
SecretListEntry |
withDescription(String description)
The user-provided description of the secret.
|
SecretListEntry |
withKmsKeyId(String kmsKeyId)
The ARN of the KMS key that Secrets Manager uses to encrypt the secret value.
|
SecretListEntry |
withLastAccessedDate(Date lastAccessedDate)
The date that the secret was last accessed in the Region.
|
SecretListEntry |
withLastChangedDate(Date lastChangedDate)
The last date and time that this secret was modified in any way.
|
SecretListEntry |
withLastRotatedDate(Date lastRotatedDate)
The most recent date and time that the Secrets Manager rotation process was successfully completed.
|
SecretListEntry |
withName(String name)
The friendly name of the secret.
|
SecretListEntry |
withNextRotationDate(Date nextRotationDate)
The next rotation is scheduled to occur on or before this date.
|
SecretListEntry |
withOwningService(String owningService)
Returns the name of the service that created the secret.
|
SecretListEntry |
withPrimaryRegion(String primaryRegion)
The Region where Secrets Manager originated the secret.
|
SecretListEntry |
withRotationEnabled(Boolean rotationEnabled)
Indicates whether automatic, scheduled rotation is enabled for this secret.
|
SecretListEntry |
withRotationLambdaARN(String rotationLambdaARN)
The ARN of an Amazon Web Services Lambda function invoked by Secrets Manager to rotate and expire the secret
either automatically per the schedule or manually by a call to
RotateSecret . |
SecretListEntry |
withRotationRules(RotationRulesType rotationRules)
A structure that defines the rotation configuration for the secret.
|
SecretListEntry |
withSecretVersionsToStages(Map<String,List<String>> secretVersionsToStages)
A list of all of the currently assigned
SecretVersionStage staging labels and the
SecretVersionId attached to each one. |
SecretListEntry |
withTags(Collection<Tag> tags)
The list of user-defined tags associated with the secret.
|
SecretListEntry |
withTags(Tag... tags)
The list of user-defined tags associated with the secret.
|
public void setARN(String aRN)
The Amazon Resource Name (ARN) of the secret.
aRN
- The Amazon Resource Name (ARN) of the secret.public String getARN()
The Amazon Resource Name (ARN) of the secret.
public SecretListEntry withARN(String aRN)
The Amazon Resource Name (ARN) of the secret.
aRN
- The Amazon Resource Name (ARN) of the secret.public void setName(String name)
The friendly name of the secret.
name
- The friendly name of the secret.public String getName()
The friendly name of the secret.
public SecretListEntry withName(String name)
The friendly name of the secret.
name
- The 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 SecretListEntry 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 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.
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.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.
aws/secretsmanager
, this field is omitted.public SecretListEntry 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.
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.public void setRotationEnabled(Boolean rotationEnabled)
Indicates whether automatic, scheduled rotation is enabled for this secret.
rotationEnabled
- Indicates whether automatic, scheduled rotation is enabled for this secret.public Boolean getRotationEnabled()
Indicates whether automatic, scheduled rotation is enabled for this secret.
public SecretListEntry withRotationEnabled(Boolean rotationEnabled)
Indicates whether automatic, scheduled rotation is enabled for this secret.
rotationEnabled
- Indicates whether automatic, scheduled rotation is enabled for this secret.public Boolean isRotationEnabled()
Indicates whether automatic, scheduled rotation is enabled for this secret.
public void setRotationLambdaARN(String rotationLambdaARN)
The ARN of an Amazon Web Services Lambda function invoked by Secrets Manager to rotate and expire the secret
either automatically per the schedule or manually by a call to
RotateSecret
.
rotationLambdaARN
- The ARN of an Amazon Web Services Lambda function invoked by Secrets Manager to rotate and expire the
secret either automatically per the schedule or manually by a call to
RotateSecret
.public String getRotationLambdaARN()
The ARN of an Amazon Web Services Lambda function invoked by Secrets Manager to rotate and expire the secret
either automatically per the schedule or manually by a call to
RotateSecret
.
RotateSecret
.public SecretListEntry withRotationLambdaARN(String rotationLambdaARN)
The ARN of an Amazon Web Services Lambda function invoked by Secrets Manager to rotate and expire the secret
either automatically per the schedule or manually by a call to
RotateSecret
.
rotationLambdaARN
- The ARN of an Amazon Web Services Lambda function invoked by Secrets Manager to rotate and expire the
secret either automatically per the schedule or manually by a call to
RotateSecret
.public void setRotationRules(RotationRulesType rotationRules)
A structure that defines the rotation configuration for the secret.
rotationRules
- A structure that defines the rotation configuration for the secret.public RotationRulesType getRotationRules()
A structure that defines the rotation configuration for the secret.
public SecretListEntry withRotationRules(RotationRulesType rotationRules)
A structure that defines the rotation configuration for the secret.
rotationRules
- A structure that defines the rotation configuration for the 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 hasn't ever rotated.
lastRotatedDate
- The most recent date and time that the Secrets Manager rotation process was successfully completed. This
value is null if the secret hasn't ever 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 hasn't ever rotated.
public SecretListEntry 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 hasn't ever rotated.
lastRotatedDate
- The most recent date and time that the Secrets Manager rotation process was successfully completed. This
value is null if the secret hasn't ever 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 SecretListEntry 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 date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.
lastAccessedDate
- The date that the secret was last accessed in the Region. This field is omitted if the secret has never
been retrieved in the Region.public Date getLastAccessedDate()
The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.
public SecretListEntry withLastAccessedDate(Date lastAccessedDate)
The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.
lastAccessedDate
- The date that the secret was last accessed in the Region. This field is omitted if the secret has never
been retrieved in the Region.public void setDeletedDate(Date deletedDate)
The date and time the deletion of the secret occurred. Not present on active secrets. The secret can be recovered
until the number of days in the recovery window has passed, as specified in the RecoveryWindowInDays
parameter of the
DeleteSecret
operation.
deletedDate
- The date and time the deletion of the secret occurred. Not present on active secrets. The secret can be
recovered until the number of days in the recovery window has passed, as specified in the
RecoveryWindowInDays
parameter of the
DeleteSecret
operation.public Date getDeletedDate()
The date and time the deletion of the secret occurred. Not present on active secrets. The secret can be recovered
until the number of days in the recovery window has passed, as specified in the RecoveryWindowInDays
parameter of the
DeleteSecret
operation.
RecoveryWindowInDays
parameter of the
DeleteSecret
operation.public SecretListEntry withDeletedDate(Date deletedDate)
The date and time the deletion of the secret occurred. Not present on active secrets. The secret can be recovered
until the number of days in the recovery window has passed, as specified in the RecoveryWindowInDays
parameter of the
DeleteSecret
operation.
deletedDate
- The date and time the deletion of the secret occurred. Not present on active secrets. The secret can be
recovered until the number of days in the recovery window has passed, as specified in the
RecoveryWindowInDays
parameter of the
DeleteSecret
operation.public void setNextRotationDate(Date nextRotationDate)
The next rotation is scheduled to occur on or before this date. If the secret isn't configured for rotation or rotation has been disabled, Secrets Manager returns null.
nextRotationDate
- The next rotation is scheduled to occur on or before this date. If the secret isn't configured for
rotation or rotation has been disabled, Secrets Manager returns null.public Date getNextRotationDate()
The next rotation is scheduled to occur on or before this date. If the secret isn't configured for rotation or rotation has been disabled, Secrets Manager returns null.
public SecretListEntry withNextRotationDate(Date nextRotationDate)
The next rotation is scheduled to occur on or before this date. If the secret isn't configured for rotation or rotation has been disabled, Secrets Manager returns null.
nextRotationDate
- The next rotation is scheduled to occur on or before this date. If the secret isn't configured for
rotation or rotation has been disabled, Secrets Manager returns null.public List<Tag> getTags()
The list of user-defined tags associated with the secret. To add tags to a secret, use
TagResource
. To remove tags, use
UntagResource
.
TagResource
. To remove tags, use
UntagResource
.public void setTags(Collection<Tag> tags)
The list of user-defined tags associated with the secret. To add tags to a secret, use
TagResource
. To remove tags, use
UntagResource
.
tags
- The list of user-defined tags associated with the secret. To add tags to a secret, use
TagResource
. To remove tags, use
UntagResource
.public SecretListEntry withTags(Tag... tags)
The list of user-defined tags 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 associated with the secret. To add tags to a secret, use
TagResource
. To remove tags, use
UntagResource
.public SecretListEntry withTags(Collection<Tag> tags)
The list of user-defined tags associated with the secret. To add tags to a secret, use
TagResource
. To remove tags, use
UntagResource
.
tags
- The list of user-defined tags associated with the secret. To add tags to a secret, use
TagResource
. To remove tags, use
UntagResource
.public Map<String,List<String>> getSecretVersionsToStages()
A list of all of the currently assigned SecretVersionStage
staging labels and the
SecretVersionId
attached to each one. Staging labels are used to keep track of the different
versions during the rotation process.
A version that does not have any SecretVersionStage
is considered deprecated and subject to
deletion. Such versions are not included in this list.
SecretVersionStage
staging labels and the
SecretVersionId
attached to each one. Staging labels are used to keep track of the different
versions during the rotation process.
A version that does not have any SecretVersionStage
is considered deprecated and subject to
deletion. Such versions are not included in this list.
public void setSecretVersionsToStages(Map<String,List<String>> secretVersionsToStages)
A list of all of the currently assigned SecretVersionStage
staging labels and the
SecretVersionId
attached to each one. Staging labels are used to keep track of the different
versions during the rotation process.
A version that does not have any SecretVersionStage
is considered deprecated and subject to
deletion. Such versions are not included in this list.
secretVersionsToStages
- A list of all of the currently assigned SecretVersionStage
staging labels and the
SecretVersionId
attached to each one. Staging labels are used to keep track of the different
versions during the rotation process.
A version that does not have any SecretVersionStage
is considered deprecated and subject to
deletion. Such versions are not included in this list.
public SecretListEntry withSecretVersionsToStages(Map<String,List<String>> secretVersionsToStages)
A list of all of the currently assigned SecretVersionStage
staging labels and the
SecretVersionId
attached to each one. Staging labels are used to keep track of the different
versions during the rotation process.
A version that does not have any SecretVersionStage
is considered deprecated and subject to
deletion. Such versions are not included in this list.
secretVersionsToStages
- A list of all of the currently assigned SecretVersionStage
staging labels and the
SecretVersionId
attached to each one. Staging labels are used to keep track of the different
versions during the rotation process.
A version that does not have any SecretVersionStage
is considered deprecated and subject to
deletion. Such versions are not included in this list.
public SecretListEntry addSecretVersionsToStagesEntry(String key, List<String> value)
public SecretListEntry clearSecretVersionsToStagesEntries()
public void setOwningService(String owningService)
Returns the name of the service that created the secret.
owningService
- Returns the name of the service that created the secret.public String getOwningService()
Returns the name of the service that created the secret.
public SecretListEntry withOwningService(String owningService)
Returns the name of the service that created the secret.
owningService
- Returns the name of the service that created the secret.public void setCreatedDate(Date createdDate)
The date and time when a secret was created.
createdDate
- The date and time when a secret was created.public Date getCreatedDate()
The date and time when a secret was created.
public SecretListEntry withCreatedDate(Date createdDate)
The date and time when a secret was created.
createdDate
- The date and time when a secret was created.public void setPrimaryRegion(String primaryRegion)
The Region where Secrets Manager originated the secret.
primaryRegion
- The Region where Secrets Manager originated the secret.public String getPrimaryRegion()
The Region where Secrets Manager originated the secret.
public SecretListEntry withPrimaryRegion(String primaryRegion)
The Region where Secrets Manager originated the secret.
primaryRegion
- The Region where Secrets Manager originated the secret.public String toString()
toString
in class Object
Object.toString()
public SecretListEntry clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.