@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 the GetSecretValue operation.
| 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 or alias of the AWS KMS customer master key (CMK) used to encrypt the
SecretString and
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 friendly name of the secret.
|
String |
getOwningService()
Returns the name of the service that created the secret.
|
Boolean |
getRotationEnabled()
Indicates whether automatic, scheduled rotation is enabled for this secret.
|
String |
getRotationLambdaARN()
The ARN of an AWS 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 or alias of the AWS KMS customer master key (CMK) used to encrypt the
SecretString and
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 friendly name of the secret.
|
void |
setOwningService(String owningService)
Returns the name of the service that created the secret.
|
void |
setRotationEnabled(Boolean rotationEnabled)
Indicates whether automatic, scheduled rotation is enabled for this secret.
|
void |
setRotationLambdaARN(String rotationLambdaARN)
The ARN of an AWS 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 or alias of the AWS KMS customer master key (CMK) used to encrypt the
SecretString and
SecretBinary fields in each version of the secret. |
SecretListEntry |
withLastAccessedDate(Date lastAccessedDate)
The last date that this secret was accessed.
|
SecretListEntry |
withLastChangedDate(Date lastChangedDate)
The last date and time that this secret was modified in any way.
|
SecretListEntry |
withLastRotatedDate(Date lastRotatedDate)
The last date and time that the rotation process for this secret was invoked.
|
SecretListEntry |
withName(String name)
The friendly name of the secret.
|
SecretListEntry |
withOwningService(String owningService)
Returns the name of the service that created the secret.
|
SecretListEntry |
withRotationEnabled(Boolean rotationEnabled)
Indicates whether automatic, scheduled rotation is enabled for this secret.
|
SecretListEntry |
withRotationLambdaARN(String rotationLambdaARN)
The ARN of an AWS 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.
For more information about ARNs in Secrets Manager, see Policy Resources in the AWS Secrets Manager User Guide.
aRN - The Amazon Resource Name (ARN) of the secret.
For more information about ARNs in Secrets Manager, see Policy Resources in the AWS Secrets Manager User Guide.
public String getARN()
The Amazon Resource Name (ARN) of the secret.
For more information about ARNs in Secrets Manager, see Policy Resources in the AWS Secrets Manager User Guide.
For more information about ARNs in Secrets Manager, see Policy Resources in the AWS Secrets Manager User Guide.
public SecretListEntry withARN(String aRN)
The Amazon Resource Name (ARN) of the secret.
For more information about ARNs in Secrets Manager, see Policy Resources in the AWS Secrets Manager User Guide.
aRN - The Amazon Resource Name (ARN) of the secret.
For more information about ARNs in Secrets Manager, see Policy Resources in the AWS Secrets Manager User Guide.
public void setName(String name)
The friendly name of the secret. You can use forward slashes in the name to represent a path hierarchy. For
example, /prod/databases/dbserver1 could represent the secret for a server named
dbserver1 in the folder databases in the folder prod.
name - The friendly name of the secret. You can use forward slashes in the name to represent a path hierarchy.
For example, /prod/databases/dbserver1 could represent the secret for a server named
dbserver1 in the folder databases in the folder prod.public String getName()
The friendly name of the secret. You can use forward slashes in the name to represent a path hierarchy. For
example, /prod/databases/dbserver1 could represent the secret for a server named
dbserver1 in the folder databases in the folder prod.
/prod/databases/dbserver1 could represent the secret for a server named
dbserver1 in the folder databases in the folder prod.public SecretListEntry withName(String name)
The friendly name of the secret. You can use forward slashes in the name to represent a path hierarchy. For
example, /prod/databases/dbserver1 could represent the secret for a server named
dbserver1 in the folder databases in the folder prod.
name - The friendly name of the secret. You can use forward slashes in the name to represent a path hierarchy.
For example, /prod/databases/dbserver1 could represent the secret for a server named
dbserver1 in the folder databases in the folder prod.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 or alias of the AWS KMS customer master key (CMK) used to encrypt the SecretString and
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 KMS CMK, the key named awssecretsmanager,
for this account.
kmsKeyId - The ARN or alias of the AWS KMS customer master key (CMK) used to encrypt the SecretString
and 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 KMS CMK, the key named
awssecretsmanager, for this account.public String getKmsKeyId()
The ARN or alias of the AWS KMS customer master key (CMK) used to encrypt the SecretString and
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 KMS CMK, the key named awssecretsmanager,
for this account.
SecretString
and 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 KMS CMK, the key named
awssecretsmanager, for this account.public SecretListEntry withKmsKeyId(String kmsKeyId)
The ARN or alias of the AWS KMS customer master key (CMK) used to encrypt the SecretString and
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 KMS CMK, the key named awssecretsmanager,
for this account.
kmsKeyId - The ARN or alias of the AWS KMS customer master key (CMK) used to encrypt the SecretString
and 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 KMS CMK, the key named
awssecretsmanager, for this account.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 AWS 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 AWS 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 AWS 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 SecretListEntry withRotationLambdaARN(String rotationLambdaARN)
The ARN of an AWS 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 AWS 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 last date and time that the rotation process for this secret was invoked.
lastRotatedDate - The last date and time that the rotation process for this secret was invoked.public Date getLastRotatedDate()
The last date and time that the rotation process for this secret was invoked.
public SecretListEntry withLastRotatedDate(Date lastRotatedDate)
The last date and time that the rotation process for this secret was invoked.
lastRotatedDate - The last date and time that the rotation process for this secret was invoked.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 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 SecretListEntry 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)
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 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.
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 String toString()
toString in class ObjectObject.toString()public SecretListEntry clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojoProtocolMarshaller.marshall in interface StructuredPojoprotocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.