Package software.amazon.awssdk.services.secretsmanager.model

Class DescribeSecretResponse

    • Method Detail

      • arn

        public final String arn()

        The ARN of the secret.

        Returns:
        The ARN of the secret.

      • name

        public final String name()

        The name of the secret.

        Returns:
        The name of the secret.

      • description

        public final String description()

        The description of the secret.

        Returns:
        The description of the secret.

      • kmsKeyId

        public final String kmsKeyId()

        The key ID or alias 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. Secrets created using the console use an KMS key ID.

        Returns:
        The key ID or alias 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. Secrets created using the console use an KMS key ID.

      • rotationEnabled

        public final Boolean rotationEnabled()

        Specifies whether automatic rotation is turned on for this secret.

        To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.

        Returns:
        Specifies whether automatic rotation is turned on for this secret.

        To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.

      • rotationLambdaARN

        public final String rotationLambdaARN()

        The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.

        Returns:
        The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.

      • rotationRules

        public final RotationRulesType rotationRules()

        The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had rotation turned on, this field is omitted.

        Returns:
        The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had rotation turned on, this field is omitted.

      • lastRotatedDate

        public final Instant lastRotatedDate()

        The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation, Secrets Manager returns null.

        Returns:
        The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation, Secrets Manager returns null.

      • lastChangedDate

        public final 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 final Instant lastAccessedDate()

        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.

        Returns:
        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.

      • deletedDate

        public final Instant deletedDate()

        The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is omitted. When you delete a secret, Secrets Manager requires a recovery window of at least 7 days before deleting the secret. Some time after the deleted date, Secrets Manager deletes the secret, including all of its versions.

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

        Returns:
        The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is omitted. When you delete a secret, Secrets Manager requires a recovery window of at least 7 days before deleting the secret. Some time after the deleted date, Secrets Manager deletes the secret, including all of its versions.

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

      • nextRotationDate

        public final Instant nextRotationDate()

        The next rotation is scheduled to occur on or before this date. If the secret isn't configured for rotation, Secrets Manager returns null.

        Returns:
        The next rotation is scheduled to occur on or before this date. If the secret isn't configured for rotation, Secrets Manager returns null.

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • tags

        public final List<Tag> tags()

        The list of tags attached to 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.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

        Returns:
        The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.

      • hasVersionIdsToStages

        public final boolean hasVersionIdsToStages()
        For responses, this returns true if the service returned a value for the VersionIdsToStages property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • versionIdsToStages

        public final Map<String,​List<String>> versionIdsToStages()

        A list of the versions of the secret that have staging labels attached. Versions that don't have staging labels are considered deprecated and Secrets Manager can delete them.

        Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three staging labels for rotation are:

        • AWSCURRENT, which indicates the current version of the secret.

        • AWSPENDING, which indicates the version of the secret that contains new secret information that will become the next current version when rotation finishes.

          During rotation, Secrets Manager creates an AWSPENDING version ID before creating the new secret version. To check if a secret version exists, call GetSecretValue.

        • AWSPREVIOUS, which indicates the previous current version of the secret. You can use this as the last known good version.

        For more information about rotation and staging labels, see How rotation works.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVersionIdsToStages() method.

        Returns:
        A list of the versions of the secret that have staging labels attached. Versions that don't have staging labels are considered deprecated and Secrets Manager can delete them.

        Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three staging labels for rotation are:

        • AWSCURRENT, which indicates the current version of the secret.

        • AWSPENDING, which indicates the version of the secret that contains new secret information that will become the next current version when rotation finishes.

          During rotation, Secrets Manager creates an AWSPENDING version ID before creating the new secret version. To check if a secret version exists, call GetSecretValue.

        • AWSPREVIOUS, which indicates the previous current version of the secret. You can use this as the last known good version.

        For more information about rotation and staging labels, see How rotation works.

      • createdDate

        public final Instant createdDate()

        The date the secret was created.

        Returns:
        The date the secret was created.

      • primaryRegion

        public final String primaryRegion()

        The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in ReplicationStatus.

        Returns:
        The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in ReplicationStatus.

      • hasReplicationStatus

        public final boolean hasReplicationStatus()
        For responses, this returns true if the service returned a value for the ReplicationStatus property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • replicationStatus

        public final List<ReplicationStatusType> replicationStatus()

        A list of the replicas of this secret and their status:

        • Failed, which indicates that the replica was not created.

        • InProgress, which indicates that Secrets Manager is in the process of creating the replica.

        • InSync, which indicates that the replica was created.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasReplicationStatus() method.

        Returns:
        A list of the replicas of this secret and their status:

        • Failed, which indicates that the replica was not created.

        • InProgress, which indicates that Secrets Manager is in the process of creating the replica.

        • InSync, which indicates that the replica was created.

      • toString

        public final 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