DescribeSecretResponse

public struct DescribeSecretResponse : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]
  • arn

    The ARN of the secret.

    Declaration

    Swift

    public let arn: String?

  • The date that the secret was created.

    Declaration

    Swift

    public let createdDate: TimeStamp?

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

    Declaration

    Swift

    public let deletedDate: TimeStamp?

  • The user-provided description of the secret.

    Declaration

    Swift

    public let description: String?

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

    Declaration

    Swift

    public let kmsKeyId: String?

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

    Declaration

    Swift

    public let lastAccessedDate: TimeStamp?

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

    Declaration

    Swift

    public let lastChangedDate: TimeStamp?

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

    Declaration

    Swift

    public let lastRotatedDate: TimeStamp?

  • The user-provided friendly name of the secret.

    Declaration

    Swift

    public let name: String?

  • Returns the name of the service that created this secret.

    Declaration

    Swift

    public let owningService: String?

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

    Declaration

    Swift

    public let rotationEnabled: Bool?

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

    Declaration

    Swift

    public let rotationLambdaARN: String?

  • A structure that contains the rotation configuration for this secret.

    Declaration

    Swift

    public let rotationRules: RotationRulesType?

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

    Declaration

    Swift

    public let tags: [Tag]?

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

    Declaration

    Swift

    public let versionIdsToStages: [String : [String]]?

  • Undocumented

    Declaration

    Swift

    public init(arn: String? = nil, createdDate: TimeStamp? = nil, deletedDate: TimeStamp? = nil, description: String? = nil, kmsKeyId: String? = nil, lastAccessedDate: TimeStamp? = nil, lastChangedDate: TimeStamp? = nil, lastRotatedDate: TimeStamp? = nil, name: String? = nil, owningService: String? = nil, rotationEnabled: Bool? = nil, rotationLambdaARN: String? = nil, rotationRules: RotationRulesType? = nil, tags: [Tag]? = nil, versionIdsToStages: [String : [String]]? = nil)