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

Interface DescribeSecretResponse.Builder

    • Method Detail

      • arn

        DescribeSecretResponse.Builder arn​(String arn)

        The ARN of the secret.

        Parameters:
        arn - The ARN of the secret.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • name

        DescribeSecretResponse.Builder name​(String name)

        The name of the secret.

        Parameters:
        name - The name of the secret.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        DescribeSecretResponse.Builder description​(String description)

        The description of the secret.

        Parameters:
        description - The description of the secret.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • kmsKeyId

        DescribeSecretResponse.Builder kmsKeyId​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • rotationEnabled

        DescribeSecretResponse.Builder rotationEnabled​(Boolean rotationEnabled)

        Specifies whether automatic rotation is turned on for this secret. If the secret has never been configured for rotation, Secrets Manager returns null.

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

        Parameters:
        rotationEnabled - Specifies whether automatic rotation is turned on for this secret. If the secret has never been configured for rotation, Secrets Manager returns null.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • rotationLambdaARN

        DescribeSecretResponse.Builder rotationLambdaARN​(String rotationLambdaARN)

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

        Parameters:
        rotationLambdaARN - The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • rotationRules

        DescribeSecretResponse.Builder rotationRules​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • lastRotatedDate

        DescribeSecretResponse.Builder lastRotatedDate​(Instant lastRotatedDate)

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

        Parameters:
        lastRotatedDate - The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation or rotation has been disabled, Secrets Manager returns null.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • lastChangedDate

        DescribeSecretResponse.Builder lastChangedDate​(Instant lastChangedDate)

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

        Parameters:
        lastChangedDate - The last date and time that this secret was modified in any way.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • lastAccessedDate

        DescribeSecretResponse.Builder lastAccessedDate​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • deletedDate

        DescribeSecretResponse.Builder deletedDate​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • nextRotationDate

        DescribeSecretResponse.Builder nextRotationDate​(Instant nextRotationDate)

        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. If rotation fails, Secrets Manager retries the entire rotation process multiple times. If rotation is unsuccessful, this date may be in the past.

        This date represents the latest date that rotation will occur, but it is not an approximate rotation date. In some cases, for example if you turn off automatic rotation and then turn it back on, the next rotation may occur much sooner than this date.

        Parameters:
        nextRotationDate - 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. If rotation fails, Secrets Manager retries the entire rotation process multiple times. If rotation is unsuccessful, this date may be in the past.

        This date represents the latest date that rotation will occur, but it is not an approximate rotation date. In some cases, for example if you turn off automatic rotation and then turn it back on, the next rotation may occur much sooner than this date.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        DescribeSecretResponse.Builder tags​(Tag... tags)

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

        Parameters:
        tags - The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • versionIdsToStages

        DescribeSecretResponse.Builder versionIdsToStages​(Map<String,​? extends Collection<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.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • createdDate

        DescribeSecretResponse.Builder createdDate​(Instant createdDate)

        The date the secret was created.

        Parameters:
        createdDate - The date the secret was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • primaryRegion

        DescribeSecretResponse.Builder primaryRegion​(String primaryRegion)

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

        Parameters:
        primaryRegion - The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in ReplicationStatus.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • replicationStatus

        DescribeSecretResponse.Builder replicationStatus​(Collection<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.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • replicationStatus

        DescribeSecretResponse.Builder replicationStatus​(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.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • replicationStatus

        DescribeSecretResponse.Builder replicationStatus​(Consumer<ReplicationStatusType.Builder>... 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.

        This is a convenience method that creates an instance of the ReplicationStatusType.Builder avoiding the need to create one manually via ReplicationStatusType.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #replicationStatus(List).

        Parameters:
        replicationStatus - a consumer that will call methods on ReplicationStatusType.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #replicationStatus(java.util.Collection)