DescribeSecretResponse.Builder (AWS Java SDK :: Services

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeSecretResponse.Builder,DescribeSecretResponse>, SdkBuilder<DescribeSecretResponse.Builder,DescribeSecretResponse>, SdkPojo, SdkResponse.Builder, SecretsManagerResponse.Builder

Enclosing class:

DescribeSecretResponse
```
public static interface DescribeSecretResponse.Builder
extends SecretsManagerResponse.Builder, SdkPojo, CopyableBuilder<DescribeSecretResponse.Builder,DescribeSecretResponse>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`DescribeSecretResponse.Builder`	`arn(String arn)` The ARN of the secret.
`DescribeSecretResponse.Builder`	`createdDate(Instant createdDate)` The date the secret was created.
`DescribeSecretResponse.Builder`	`deletedDate(Instant deletedDate)` The date the secret is scheduled for deletion.
`DescribeSecretResponse.Builder`	`description(String description)` The description of the secret.
`DescribeSecretResponse.Builder`	`kmsKeyId(String kmsKeyId)` The key ID or alias ARN of the KMS key that Secrets Manager uses to encrypt the secret value.
`DescribeSecretResponse.Builder`	`lastAccessedDate(Instant lastAccessedDate)` The date that the secret was last accessed in the Region.
`DescribeSecretResponse.Builder`	`lastChangedDate(Instant lastChangedDate)` The last date and time that this secret was modified in any way.
`DescribeSecretResponse.Builder`	`lastRotatedDate(Instant lastRotatedDate)` The last date and time that Secrets Manager rotated the secret.
`DescribeSecretResponse.Builder`	`name(String name)` The name of the secret.
`DescribeSecretResponse.Builder`	`nextRotationDate(Instant nextRotationDate)` The next date and time that Secrets Manager will rotate the secret, rounded to the nearest hour.
`DescribeSecretResponse.Builder`	`owningService(String owningService)` The ID of the service that created this secret.
`DescribeSecretResponse.Builder`	`primaryRegion(String primaryRegion)` The Region the secret is in.
`DescribeSecretResponse.Builder`	`replicationStatus(Collection<ReplicationStatusType> replicationStatus)` A list of the replicas of this secret and their status:
`DescribeSecretResponse.Builder`	`replicationStatus(Consumer<ReplicationStatusType.Builder>... replicationStatus)` A list of the replicas of this secret and their status:
`DescribeSecretResponse.Builder`	`replicationStatus(ReplicationStatusType... replicationStatus)` A list of the replicas of this secret and their status:
`DescribeSecretResponse.Builder`	`rotationEnabled(Boolean rotationEnabled)` Specifies whether automatic rotation is turned on for this secret.
`DescribeSecretResponse.Builder`	`rotationLambdaARN(String rotationLambdaARN)` The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
`default DescribeSecretResponse.Builder`	`rotationRules(Consumer<RotationRulesType.Builder> rotationRules)` The rotation schedule and Lambda function for this secret.
`DescribeSecretResponse.Builder`	`rotationRules(RotationRulesType rotationRules)` The rotation schedule and Lambda function for this secret.
`DescribeSecretResponse.Builder`	`tags(Collection<Tag> tags)` The list of tags attached to the secret.
`DescribeSecretResponse.Builder`	`tags(Consumer<Tag.Builder>... tags)` The list of tags attached to the secret.
`DescribeSecretResponse.Builder`	`tags(Tag... tags)` The list of tags attached to the secret.
`DescribeSecretResponse.Builder`	`versionIdsToStages(Map<String,? extends Collection<String>> versionIdsToStages)` A list of the versions of the secret that have staging labels attached.

Methods inherited from interface software.amazon.awssdk.services.secretsmanager.model.SecretsManagerResponse.Builder
build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- 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.
    
    To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
    
    Parameters:
    
    rotationEnabled - Specifies whether automatic rotation is turned on for this secret.
    
    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.
  - rotationRules
```
default DescribeSecretResponse.Builder rotationRules(Consumer<RotationRulesType.Builder> 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.
    This is a convenience method that creates an instance of the RotationRulesType.Builder avoiding the need to create one manually via RotationRulesType.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to rotationRules(RotationRulesType).
    
    Parameters:
    
    rotationRules - a consumer that will call methods on RotationRulesType.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    rotationRules(RotationRulesType)
  - 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, 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, 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 date and time that Secrets Manager will rotate the secret, rounded to the nearest hour. If the secret isn't configured for rotation, Secrets Manager returns null.
    
    Parameters:
    
    nextRotationDate - The next date and time that Secrets Manager will rotate the secret, rounded to the nearest hour. If the secret isn't configured for rotation, Secrets Manager returns null.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - tags
```
DescribeSecretResponse.Builder tags(Collection<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.
  - 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.
  - tags
```
DescribeSecretResponse.Builder tags(Consumer<Tag.Builder>... tags)
```
    The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
    This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).
    
    Parameters:
    
    tags - a consumer that will call methods on Tag.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #tags(java.util.Collection)
  - 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.
  - owningService
```
DescribeSecretResponse.Builder owningService(String owningService)
```
    The ID of the service that created this secret. For more information, see Secrets managed by other Amazon Web Services services.
    
    Parameters:
    
    owningService - The ID of the service that created this secret. For more information, see Secrets managed by other Amazon Web Services services.
    
    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)

Interface DescribeSecretResponse.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.services.secretsmanager.model.SecretsManagerResponse.Builder

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

Method Detail

arn

name

description

kmsKeyId

rotationEnabled

rotationLambdaARN

rotationRules

rotationRules

lastRotatedDate

lastChangedDate

lastAccessedDate

deletedDate

nextRotationDate

tags

tags

tags

versionIdsToStages

owningService

createdDate

primaryRegion

replicationStatus

replicationStatus

replicationStatus