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

Interface SecretListEntry.Builder

    • Method Detail

      • arn

        SecretListEntry.Builder arn​(String arn)

        The Amazon Resource Name (ARN) of the secret.

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

      • name

        SecretListEntry.Builder name​(String name)

        The friendly name of the secret.

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

      • description

        SecretListEntry.Builder description​(String description)

        The user-provided description of the secret.

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

      • kmsKeyId

        SecretListEntry.Builder kmsKeyId​(String kmsKeyId)

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

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

      • rotationEnabled

        SecretListEntry.Builder rotationEnabled​(Boolean rotationEnabled)

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

        Parameters:
        rotationEnabled - Indicates whether automatic, scheduled rotation is enabled for this secret.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • rotationLambdaARN

        SecretListEntry.Builder rotationLambdaARN​(String rotationLambdaARN)

        The ARN of an Amazon Web Services Lambda function invoked by Secrets Manager to rotate and expire the secret either automatically per the schedule or manually by a call to RotateSecret .

        Parameters:
        rotationLambdaARN - The ARN of an Amazon Web Services Lambda function invoked by Secrets Manager to rotate and expire the secret either automatically per the schedule or manually by a call to RotateSecret .
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • rotationRules

        SecretListEntry.Builder rotationRules​(RotationRulesType rotationRules)

        A structure that defines the rotation configuration for the secret.

        Parameters:
        rotationRules - A structure that defines the rotation configuration for the secret.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • externalSecretRotationMetadata

        SecretListEntry.Builder externalSecretRotationMetadata​(Collection<ExternalSecretRotationMetadataItem> externalSecretRotationMetadata)

        The metadata needed to successfully rotate a managed external secret. A list of key value pairs in JSON format specified by the partner. For more information about the required information, see Managed external secrets partners.

        Parameters:
        externalSecretRotationMetadata - The metadata needed to successfully rotate a managed external secret. A list of key value pairs in JSON format specified by the partner. For more information about the required information, see Managed external secrets partners.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • externalSecretRotationMetadata

        SecretListEntry.Builder externalSecretRotationMetadata​(ExternalSecretRotationMetadataItem... externalSecretRotationMetadata)

        The metadata needed to successfully rotate a managed external secret. A list of key value pairs in JSON format specified by the partner. For more information about the required information, see Managed external secrets partners.

        Parameters:
        externalSecretRotationMetadata - The metadata needed to successfully rotate a managed external secret. A list of key value pairs in JSON format specified by the partner. For more information about the required information, see Managed external secrets partners.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • externalSecretRotationRoleArn

        SecretListEntry.Builder externalSecretRotationRoleArn​(String externalSecretRotationRoleArn)

        The role that Secrets Manager assumes to call APIs required to perform the rotation. For more information about the required information, see Managed external secrets partners.

        Parameters:
        externalSecretRotationRoleArn - The role that Secrets Manager assumes to call APIs required to perform the rotation. For more information about the required information, see Managed external secrets partners.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • lastRotatedDate

        SecretListEntry.Builder lastRotatedDate​(Instant lastRotatedDate)

        The most recent date and time that the Secrets Manager rotation process was successfully completed. This value is null if the secret hasn't ever rotated.

        Parameters:
        lastRotatedDate - The most recent date and time that the Secrets Manager rotation process was successfully completed. This value is null if the secret hasn't ever rotated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • lastChangedDate

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

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

        SecretListEntry.Builder deletedDate​(Instant deletedDate)

        The date and time the deletion of the secret occurred. 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.

        Parameters:
        deletedDate - The date and time the deletion of the secret occurred. 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • nextRotationDate

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

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

      • tags

        SecretListEntry.Builder tags​(Tag... tags)

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

        Parameters:
        tags - The list of user-defined tags associated with 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.

      • secretVersionsToStages

        SecretListEntry.Builder secretVersionsToStages​(Map<String,​? extends Collection<String>> secretVersionsToStages)

        A list of all of the currently assigned SecretVersionStage staging labels and the SecretVersionId attached to each one. 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.

        Parameters:
        secretVersionsToStages - A list of all of the currently assigned SecretVersionStage staging labels and the SecretVersionId attached to each one. 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.

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

      • owningService

        SecretListEntry.Builder owningService​(String owningService)

        Returns the name of the service that created the secret.

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

      • createdDate

        SecretListEntry.Builder createdDate​(Instant createdDate)

        The date and time when a secret was created.

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

      • primaryRegion

        SecretListEntry.Builder primaryRegion​(String primaryRegion)

        The Region where Secrets Manager originated the secret.

        Parameters:
        primaryRegion - The Region where Secrets Manager originated the secret.
        Returns:
        Returns a reference to this object so that method calls can be chained together.