/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::SecretsManager::RotateSecret

NAME

Paws::SecretsManager::RotateSecret - Arguments for method RotateSecret on Paws::SecretsManager

DESCRIPTION

This class represents the parameters used for calling the method RotateSecret on the AWS Secrets Manager service. Use the attributes of this class as arguments to method RotateSecret.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RotateSecret.

SYNOPSIS

my $secretsmanager = Paws->service('SecretsManager');
# To configure rotation for a secret
# The following example configures rotation for a secret by providing the ARN of
# a Lambda rotation function (which must already exist) and the number of days
# between rotation. The first rotation happens immediately upon completion of
# this command. The rotation function runs asynchronously in the background.
my $RotateSecretResponse = $secretsmanager->RotateSecret(
  'RotationLambdaARN' =>
'arn:aws:lambda:us-west-2:123456789012:function:MyTestDatabaseRotationLambda',
  'RotationRules' => {
    'AutomaticallyAfterDays' => 30
  },
  'SecretId' => 'MyTestDatabaseSecret'
);

# Results:
my $ARN       = $RotateSecretResponse->ARN;
my $Name      = $RotateSecretResponse->Name;
my $VersionId = $RotateSecretResponse->VersionId;

# Returns a L<Paws::SecretsManager::RotateSecretResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/secretsmanager/RotateSecret

ATTRIBUTES

ClientRequestToken => Str

(Optional) Specifies a unique identifier for the new version of the secret that helps ensure idempotency.

If you use the AWS CLI or one of the AWS SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for new versions and include that value in the request.

You only need to specify your own value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type (https://wikipedia.org/wiki/Universally_unique_identifier) value to ensure uniqueness within the specified secret.

Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the function's processing. This value becomes the VersionId of the new version.

RotationLambdaARN => Str

(Optional) Specifies the ARN of the Lambda function that can rotate the secret.

RotationRules => Paws::SecretsManager::RotationRulesType

A structure that defines the rotation configuration for this secret.

REQUIRED SecretId => Str

Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.

If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

SEE ALSO

This class forms part of Paws, documenting arguments for method RotateSecret in Paws::SecretsManager

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues