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

Class RotateSecretRequest

    • Method Detail

      • secretId

        public final 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.

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

      • clientRequestToken

        public final 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.

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

      • rotationLambdaARN

        public final 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.

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

      • rotationRules

        public final RotationRulesType rotationRules()

        A structure that defines the rotation configuration for this secret.

        When changing an existing rotation schedule and setting RotateImmediately to false:

        • If using AutomaticallyAfterDays or a ScheduleExpression with rate(), the previously scheduled rotation might still occur.

        • To prevent unintended rotations, use a ScheduleExpression with cron() for granular control over rotation windows.

        Returns:
        A structure that defines the rotation configuration for this secret.

        When changing an existing rotation schedule and setting RotateImmediately to false:

        • If using AutomaticallyAfterDays or a ScheduleExpression with rate(), the previously scheduled rotation might still occur.

        • To prevent unintended rotations, use a ScheduleExpression with cron() for granular control over rotation windows.

      • hasExternalSecretRotationMetadata

        public final boolean hasExternalSecretRotationMetadata()
        For responses, this returns true if the service returned a value for the ExternalSecretRotationMetadata property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • externalSecretRotationMetadata

        public final List<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 Using Secrets Manager managed external secrets

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasExternalSecretRotationMetadata() method.

        Returns:
        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 Using Secrets Manager managed external secrets

      • externalSecretRotationRoleArn

        public final String externalSecretRotationRoleArn()

        The Amazon Resource Name (ARN) of the role that allows Secrets Manager to rotate a secret held by a third-party partner. For more information, see Security and permissions.

        Returns:
        The Amazon Resource Name (ARN) of the role that allows Secrets Manager to rotate a secret held by a third-party partner. For more information, see Security and permissions.

      • rotateImmediately

        public final 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.

        The default for RotateImmediately is true. If you don't specify this value, Secrets Manager rotates the secret immediately.

        If you set RotateImmediately to false, Secrets Manager tests the rotation configuration by running the testSecret step of the Lambda rotation function. This test creates an AWSPENDING version of the secret and then removes it.

        When changing an existing rotation schedule and setting RotateImmediately to false:

        • If using AutomaticallyAfterDays or a ScheduleExpression with rate(), the previously scheduled rotation might still occur.

        • To prevent unintended rotations, use a ScheduleExpression with cron() for granular control over rotation windows.

        Rotation is an asynchronous process. For more information, see How rotation works.

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

        The default for RotateImmediately is true. If you don't specify this value, Secrets Manager rotates the secret immediately.

        If you set RotateImmediately to false, Secrets Manager tests the rotation configuration by running the testSecret step of the Lambda rotation function. This test creates an AWSPENDING version of the secret and then removes it.

        When changing an existing rotation schedule and setting RotateImmediately to false:

        • If using AutomaticallyAfterDays or a ScheduleExpression with rate(), the previously scheduled rotation might still occur.

        • To prevent unintended rotations, use a ScheduleExpression with cron() for granular control over rotation windows.

        Rotation is an asynchronous process. For more information, see How rotation works.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object