SecretListEntry (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.secretsmanager.model.SecretListEntry

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SecretListEntry.Builder,SecretListEntry>
```
@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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface SecretListEntry.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`SecretListEntry.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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 last date and time that the rotation process for this secret was invoked.
`String`	`name()` The friendly name of the secret.
`String`	`owningService()` Returns the name of the service that created 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.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - arn
```
public 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.
    
    Returns:
    
    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.
  - name
```
public 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.
    
    Returns:
    
    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.
  - description
```
public String description()
```
    The user-provided description of the secret.
    
    Returns:
    
    The user-provided description of the secret.
  - kmsKeyId
```
public 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.
    
    Returns:
    
    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.
  - rotationEnabled
```
public Boolean rotationEnabled()
```
    Indicates whether automatic, scheduled rotation is enabled for this secret.
    
    Returns:
    
    Indicates whether automatic, scheduled rotation is enabled for this secret.
  - rotationLambdaARN
```
public 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.
    
    Returns:
    
    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.
  - rotationRules
```
public RotationRulesType rotationRules()
```
    A structure that defines the rotation configuration for the secret.
    
    Returns:
    
    A structure that defines the rotation configuration for the secret.
  - lastRotatedDate
```
public Instant lastRotatedDate()
```
    The last date and time that the rotation process for this secret was invoked.
    
    Returns:
    
    The last date and time that the rotation process for this secret was invoked.
  - lastChangedDate
```
public Instant lastChangedDate()
```
    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.
  - lastAccessedDate
```
public 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.
    
    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.
  - deletedDate
```
public 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.
    
    Returns:
    
    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.
  - hasTags
```
public 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). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public 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.
    
    Returns:
    
    The list of user-defined tags associated with the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
  - hasSecretVersionsToStages
```
public 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). For responses returned by the SDK, the sender is the AWS service.
  - secretVersionsToStages
```
public 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.
    
    Returns:
    
    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.
  - owningService
```
public String owningService()
```
    Returns the name of the service that created the secret.
    
    Returns:
    
    Returns the name of the service that created the secret.
  - createdDate
```
public Instant createdDate()
```
    The date and time when a secret was created.
    
    Returns:
    
    The date and time when a secret was created.
  - toBuilder
```
public SecretListEntry.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SecretListEntry.Builder,SecretListEntry>
    
    Returns:
    
    a builder for type T
  - builder
```
public static SecretListEntry.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SecretListEntry.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Description copied from interface: SdkPojo
    
    Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an 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.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

AWS SDK for Java API Reference - 2.14.21

Class SecretListEntry

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

arn

name

description

kmsKeyId

rotationEnabled

rotationLambdaARN

rotationRules

lastRotatedDate

lastChangedDate

lastAccessedDate

deletedDate

hasTags

tags

hasSecretVersionsToStages

secretVersionsToStages

owningService

createdDate

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

Copyright © 2020 Amazon Web Services, Inc. All Rights Reserved.