Class DescribeSecretResponse

Namespace

Amazon.SecretsManager.Model

Assembly

AWSSDK.SecretsManager.dll

This is the response object from the DescribeSecret operation.

public class DescribeSecretResponse : AmazonWebServiceResponse

Inheritance

object

DescribeSecretResponse

Constructors

DescribeSecretResponse()

public DescribeSecretResponse()

Properties

ARN

Gets and sets the property ARN.

The ARN of the secret.

public string ARN { get; set; }

Property Value

string

CreatedDate

Gets and sets the property CreatedDate.

The date that the secret was created.

public DateTime CreatedDate { get; set; }

Property Value

DateTime

DeletedDate

Gets and sets the property DeletedDate.

This value exists if the secret is scheduled for deletion. Some time after the specified date and time, Secrets Manager deletes the secret and all of its versions.

If a secret is scheduled for deletion, then its details, including the encrypted secret information, is not accessible. To cancel a scheduled deletion and restore access, use RestoreSecret.

public DateTime DeletedDate { get; set; }

Property Value

DateTime

Description

Gets and sets the property Description.

The user-provided description of the secret.

public string Description { get; set; }

Property Value

string

KmsKeyId

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

or

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 AWS KMS CMK (the one named

awssecretsmanager

) for this account.

public string KmsKeyId { get; set; }

Property Value

string

LastAccessedDate

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 DateTime LastAccessedDate { get; set; }

Property Value

DateTime

LastChangedDate

Gets and sets the property LastChangedDate.

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

public DateTime LastChangedDate { get; set; }

Property Value

DateTime

LastRotatedDate

Gets and sets the property LastRotatedDate.

The most recent date and time that the Secrets Manager rotation process was successfully completed. This value is null if the secret has never rotated.

public DateTime LastRotatedDate { get; set; }

Property Value

DateTime

Name

Gets and sets the property Name.

The user-provided friendly name of the secret.

public string Name { get; set; }

Property Value

string

OwningService

Gets and sets the property OwningService.

Returns the name of the service that created this secret.

public string OwningService { get; set; }

Property Value

string

RotationEnabled

Gets and sets the property RotationEnabled.

Specifies whether automatic rotation is enabled for this secret.

To enable rotation, use RotateSecret with

AutomaticallyRotateAfterDays

set to a value greater than 0. To disable rotation, use CancelRotateSecret.

public bool RotationEnabled { get; set; }

Property Value

bool

RotationLambdaARN

Gets and sets the property RotationLambdaARN.

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

RotateSecret

.

public string RotationLambdaARN { get; set; }

Property Value

string

RotationRules

Gets and sets the property RotationRules.

A structure that contains the rotation configuration for this secret.

public RotationRulesType RotationRules { get; set; }

Property Value

RotationRulesType

Tags

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.

public List<Tag> Tags { get; set; }

Property Value

List<Tag>

VersionIdsToStages

Gets and sets the property VersionIdsToStages.

A list of all of the currently assigned

VersionStage

staging labels and the

VersionId

that each is attached to. Staging labels are used to keep track of the different versions during the rotation process.

note

A version that does not have any staging labels attached is considered deprecated and subject to deletion. Such versions are not included in this list.

public Dictionary<string, List<string>> VersionIdsToStages { get; set; }

Property Value

Dictionary<string, List<string>>