@Generated(value="software.amazon.awssdk:codegen") public final class SecretListEntry extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SecretListEntry.Builder,SecretListEntry>
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.
Modifier and Type | Class and Description |
---|---|
static interface |
SecretListEntry.Builder |
Modifier and Type | Method and Description |
---|---|
String |
arn()
The Amazon Resource Name (ARN) of the secret.
|
static SecretListEntry.Builder |
builder() |
Instant |
createdDate()
The date and time when a secret was created.
|
Instant |
deletedDate()
The date and time the deletion of the secret occurred.
|
String |
description()
The user-provided description of the secret.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasSecretVersionsToStages()
Returns true if the SecretVersionsToStages property was specified by the sender (it may be empty), or false if
the sender did not specify the value (it will be empty).
|
boolean |
hasTags()
Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not
specify the value (it will be empty).
|
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. |
Instant |
lastAccessedDate()
The last date that this secret was accessed.
|
Instant |
lastChangedDate()
The last date and time that this secret was modified in any way.
|
Instant |
lastRotatedDate()
The most recent date and time that the Secrets Manager rotation process was successfully completed.
|
String |
name()
The friendly name of the secret.
|
String |
owningService()
Returns the name of the service that created the secret.
|
String |
primaryRegion()
The Region where Secrets Manager originated the secret.
|
Boolean |
rotationEnabled()
Indicates whether automatic, scheduled rotation is enabled for this secret.
|
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.
|
RotationRulesType |
rotationRules()
A structure that defines the rotation configuration for the secret.
|
List<SdkField<?>> |
sdkFields() |
Map<String,List<String>> |
secretVersionsToStages()
A list of all of the currently assigned
SecretVersionStage staging labels and the
SecretVersionId attached to each one. |
static Class<? extends SecretListEntry.Builder> |
serializableBuilderClass() |
List<Tag> |
tags()
The list of user-defined tags associated with the secret.
|
SecretListEntry.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
copy
public final 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.
For more information about ARNs in Secrets Manager, see Policy Resources in the AWS Secrets Manager User Guide.
public final 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
.
/prod/databases/dbserver1
could represent the secret for a server named
dbserver1
in the folder databases
in the folder prod
.public final String description()
The user-provided description of the secret.
public final 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.
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 final Boolean rotationEnabled()
Indicates whether automatic, scheduled rotation is enabled for this secret.
public final 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.
public final RotationRulesType rotationRules()
A structure that defines the rotation configuration for the secret.
public final Instant 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 final Instant lastChangedDate()
The last date and time that this secret was modified in any way.
public final Instant 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 final Instant 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.
RecoveryWindowInDays
parameter of the DeleteSecret operation.public final boolean hasTags()
public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasTags()
to see if a value was sent in this field.
public final boolean hasSecretVersionsToStages()
public final 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasSecretVersionsToStages()
to see if a value was sent in this field.
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 final String owningService()
Returns the name of the service that created the secret.
public final Instant createdDate()
The date and time when a secret was created.
public final String primaryRegion()
The Region where Secrets Manager originated the secret.
public SecretListEntry.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<SecretListEntry.Builder,SecretListEntry>
public static SecretListEntry.Builder builder()
public static Class<? extends SecretListEntry.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()