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

Interface RotateSecretRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<RotateSecretRequest.Builder,RotateSecretRequest>, SdkBuilder<RotateSecretRequest.Builder,RotateSecretRequest>, SdkPojo, SdkRequest.Builder, SecretsManagerRequest.Builder
Enclosing class:
RotateSecretRequest
public static interface RotateSecretRequest.Builder extends SecretsManagerRequest.Builder, SdkPojo, CopyableBuilder<RotateSecretRequest.Builder,RotateSecretRequest>

  • Method Details

    • secretId

      RotateSecretRequest.Builder secretId(String secretId)

      The ARN or name of the secret to rotate.

      For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

      Parameters:
      secretId - The ARN or name of the secret to rotate.

      For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

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

    • clientRequestToken

      RotateSecretRequest.Builder clientRequestToken(String clientRequestToken)

      A unique identifier for the new version of the secret. You only need to specify this value if you implement your own retry logic and you want to ensure that Secrets Manager doesn't attempt to create a secret version twice.

      If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.

      If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken and include it in the request.

      This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.

      Parameters:
      clientRequestToken - A unique identifier for the new version of the secret. You only need to specify this value if you implement your own retry logic and you want to ensure that Secrets Manager doesn't attempt to create a secret version twice.

      If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.

      If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken and include it in the request.

      This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.

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

    • rotationLambdaARN

      RotateSecretRequest.Builder rotationLambdaARN(String rotationLambdaARN)

      For secrets that use a Lambda rotation function to rotate, the ARN of the Lambda rotation function.

      For secrets that use managed rotation, omit this field. For more information, see Managed rotation in the Secrets Manager User Guide.

      Parameters:
      rotationLambdaARN - For secrets that use a Lambda rotation function to rotate, the ARN of the Lambda rotation function.

      For secrets that use managed rotation, omit this field. For more information, see Managed rotation in the Secrets Manager User Guide.

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

    • rotationRules

      RotateSecretRequest.Builder rotationRules(RotationRulesType rotationRules)

      A structure that defines the rotation configuration for this secret.

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

    • rotationRules

      default RotateSecretRequest.Builder rotationRules(Consumer<RotationRulesType.Builder> rotationRules)

      A structure that defines the rotation configuration for this secret.

      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:

    • rotateImmediately

      RotateSecretRequest.Builder rotateImmediately(Boolean rotateImmediately)

      Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window. The rotation schedule is defined in RotateSecretRequest$RotationRules.

      For secrets that use a Lambda rotation function to rotate, if you don't immediately rotate the secret, Secrets Manager tests the rotation configuration by running the testSecret step of the Lambda rotation function. The test creates an AWSPENDING version of the secret and then removes it.

      By default, Secrets Manager rotates the secret immediately.

      Parameters:
      rotateImmediately - Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window. The rotation schedule is defined in RotateSecretRequest$RotationRules.

      For secrets that use a Lambda rotation function to rotate, if you don't immediately rotate the secret, Secrets Manager tests the rotation configuration by running the testSecret step of the Lambda rotation function. The test creates an AWSPENDING version of the secret and then removes it.

      By default, Secrets Manager rotates the secret immediately.

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

    • overrideConfiguration

      RotateSecretRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      RotateSecretRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.