secretsmanager/aws.sdk.kotlin.services.secretsmanager.model/SecretListEntry

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 GetSecretValue .

Types

Builder

class Builder

Companion

object Companion

Properties

arn

val arn: String?

The Amazon Resource Name (ARN) of the secret.

createdDate

val createdDate: Instant?

The date and time when a secret was created.

deletedDate

val deletedDate: Instant?

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.

description

val description: String?

The user-provided description of the secret.

externalSecretRotationMetadata

val externalSecretRotationMetadata: List<ExternalSecretRotationMetadataItem>?

The metadata needed to successfully rotate a managed external secret. A list of key value pairs in JSON format specified by the partner. For more information about the required information, see Managed external secrets partners.

externalSecretRotationRoleArn

val externalSecretRotationRoleArn: String?

The role that Secrets Manager assumes to call APIs required to perform the rotation. For more information about the required information, see Managed external secrets partners.

kmsKeyId

val kmsKeyId: String?

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.

lastAccessedDate

val lastAccessedDate: Instant?

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.

lastChangedDate

val lastChangedDate: Instant?

The last date and time that this secret was modified in any way.

lastRotatedDate

val lastRotatedDate: Instant?

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.

name

val name: String?

The friendly name of the secret.

nextRotationDate

val nextRotationDate: Instant?

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.

owningService

val owningService: String?

Returns the name of the service that created the secret.

primaryRegion

val primaryRegion: String?

The Region where Secrets Manager originated the secret.

rotationEnabled

val rotationEnabled: Boolean?

Indicates whether automatic, scheduled rotation is enabled for this secret.

rotationLambdaArn

val rotationLambdaArn: String?

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.

rotationRules

val rotationRules: RotationRulesType?

A structure that defines the rotation configuration for the secret.

secretVersionsToStages

val secretVersionsToStages: Map<String, List<String>>?

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.

Functions

copy

inline fun copy(block: SecretListEntry.Builder.() -> Unit = {}): SecretListEntry

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String