AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Inheritance Hierarchy

System.Object
  Amazon.SecretsManager.Model.SecretListEntry

Namespace: Amazon.SecretsManager.Model
Assembly: AWSSDK.SecretsManager.dll
Version: 3.x.y.z

Syntax

C#
public class SecretListEntry

The SecretListEntry type exposes the following members

Constructors

NameDescription
Public Method SecretListEntry()

Properties

NameTypeDescription
Public Property ARN System.String

Gets and sets the property 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 Property DeletedDate System.DateTime

Gets and sets the property DeletedDate.

The date and time on which this secret was deleted. 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 Property Description System.String

Gets and sets the property Description.

The user-provided description of the secret.

Public Property KmsKeyId System.String

Gets and sets the property KmsKeyId.

The ARN or alias of the AWS KMS customer master key (CMK) that's 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 one named awssecretsmanager) for this account.

Public Property LastAccessedDate System.DateTime

Gets and sets the property 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 Property LastChangedDate System.DateTime

Gets and sets the property LastChangedDate.

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

Public Property LastRotatedDate System.DateTime

Gets and sets the property LastRotatedDate.

The last date and time that the rotation process for this secret was invoked.

Public Property Name System.String

Gets and sets the property 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 Property RotationEnabled System.Boolean

Gets and sets the property RotationEnabled.

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

Public Property RotationLambdaARN System.String

Gets and sets the property RotationLambdaARN.

The ARN of an AWS Lambda function that's invoked by Secrets Manager to rotate and expire the secret either automatically per the schedule or manually by a call to RotateSecret.

Public Property RotationRules Amazon.SecretsManager.Model.RotationRulesType

Gets and sets the property RotationRules.

A structure that defines the rotation configuration for the secret.

Public Property SecretVersionsToStages System.Collections.Generic.Dictionary<System.String, System.Collections.Generic.List<System.String>>

Gets and sets the property SecretVersionsToStages.

A list of all of the currently assigned SecretVersionStage staging labels and the SecretVersionId that each is attached to. 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 Property Tags System.Collections.Generic.List<Amazon.SecretsManager.Model.Tag>

Gets and sets the property Tags.

The list of user-defined tags that are associated with the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms