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

NAME

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

DESCRIPTION

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

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

SYNOPSIS

my $secretsmanager = Paws->service('SecretsManager');
# To cancel scheduled rotation for a secret
# The following example shows how to cancel rotation for a secret. The operation
# sets the RotationEnabled field to false and cancels all scheduled rotations.
# To resume scheduled rotations, you must re-enable rotation by calling the
# rotate-secret operation.
my $CancelRotateSecretResponse = $secretsmanager->CancelRotateSecret(
  'SecretId' => 'MyTestDatabaseSecret' );

# Results:
my $ARN  = $CancelRotateSecretResponse->ARN;
my $Name = $CancelRotateSecretResponse->Name;

# Returns a L<Paws::SecretsManager::CancelRotateSecretResponse> 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/CancelRotateSecret

ATTRIBUTES

REQUIRED SecretId => Str

Specifies the secret to cancel a rotation request. 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 CancelRotateSecret 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