Interface AwsSecretsManagerSecretDetails.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<AwsSecretsManagerSecretDetails.Builder,
,AwsSecretsManagerSecretDetails> SdkBuilder<AwsSecretsManagerSecretDetails.Builder,
,AwsSecretsManagerSecretDetails> SdkPojo
- Enclosing class:
AwsSecretsManagerSecretDetails
public static interface AwsSecretsManagerSecretDetails.Builder
extends SdkPojo, CopyableBuilder<AwsSecretsManagerSecretDetails.Builder,AwsSecretsManagerSecretDetails>
-
Method Summary
Modifier and TypeMethodDescriptionWhether the secret is deleted.description
(String description) The user-provided description of the secret.The ARN, Key ID, or alias of the KMS key used to encrypt theSecretString
orSecretBinary
values for versions of this secret.The name of the secret.rotationEnabled
(Boolean rotationEnabled) Whether rotation is enabled.rotationLambdaArn
(String rotationLambdaArn) The ARN of the Lambda function that rotates the secret.rotationOccurredWithinFrequency
(Boolean rotationOccurredWithinFrequency) Whether the rotation occurred within the specified rotation frequency.rotationRules
(Consumer<AwsSecretsManagerSecretRotationRules.Builder> rotationRules) Defines the rotation schedule for the secret.rotationRules
(AwsSecretsManagerSecretRotationRules rotationRules) Defines the rotation schedule for the secret.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
rotationRules
AwsSecretsManagerSecretDetails.Builder rotationRules(AwsSecretsManagerSecretRotationRules rotationRules) Defines the rotation schedule for the secret.
- Parameters:
rotationRules
- Defines the rotation schedule for the secret.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
rotationRules
default AwsSecretsManagerSecretDetails.Builder rotationRules(Consumer<AwsSecretsManagerSecretRotationRules.Builder> rotationRules) Defines the rotation schedule for the secret.
This is a convenience method that creates an instance of theAwsSecretsManagerSecretRotationRules.Builder
avoiding the need to create one manually viaAwsSecretsManagerSecretRotationRules.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed torotationRules(AwsSecretsManagerSecretRotationRules)
.- Parameters:
rotationRules
- a consumer that will call methods onAwsSecretsManagerSecretRotationRules.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
rotationOccurredWithinFrequency
AwsSecretsManagerSecretDetails.Builder rotationOccurredWithinFrequency(Boolean rotationOccurredWithinFrequency) Whether the rotation occurred within the specified rotation frequency.
- Parameters:
rotationOccurredWithinFrequency
- Whether the rotation occurred within the specified rotation frequency.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
kmsKeyId
The ARN, Key ID, or alias of the KMS key used to encrypt the
SecretString
orSecretBinary
values for versions of this secret.- Parameters:
kmsKeyId
- The ARN, Key ID, or alias of the KMS key used to encrypt theSecretString
orSecretBinary
values for versions of this secret.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
rotationEnabled
Whether rotation is enabled.
- Parameters:
rotationEnabled
- Whether rotation is enabled.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
rotationLambdaArn
The ARN of the Lambda function that rotates the secret.
- Parameters:
rotationLambdaArn
- The ARN of the Lambda function that rotates the secret.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
deleted
Whether the secret is deleted.
- Parameters:
deleted
- Whether the secret is deleted.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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.
-