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

NAME

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

DESCRIPTION

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

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

SYNOPSIS

my $secretsmanager = Paws->service('SecretsManager');
# To delete a secret
# The following example shows how to delete a secret. The secret stays in your
# account in a deprecated and inaccessible state until the recovery window ends.
# After the date and time in the DeletionDate response field has passed, you can
# no longer recover this secret with restore-secret.
my $DeleteSecretResponse = $secretsmanager->DeleteSecret(
  'RecoveryWindowInDays' => 7,
  'SecretId'             => 'MyTestDatabaseSecret1'
);

# Results:
my $ARN          = $DeleteSecretResponse->ARN;
my $DeletionDate = $DeleteSecretResponse->DeletionDate;
my $Name         = $DeleteSecretResponse->Name;

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

ATTRIBUTES

ForceDeleteWithoutRecovery => Bool

(Optional) Specifies that the secret is to be deleted without any recovery window. You can't use both this parameter and the RecoveryWindowInDays parameter in the same API call.

An asynchronous background process performs the actual deletion, so there can be a short delay before the operation completes. If you write code to delete and then immediately recreate a secret with the same name, ensure that your code includes appropriate back off and retry logic.

Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the permanent deletion that AWS would normally impose with the RecoveryWindowInDays parameter. If you delete a secret with the ForceDeleteWithouRecovery parameter, then you have no opportunity to recover the secret. You lose the secret permanently.

If you use this parameter and include a previously deleted or nonexistent secret, the operation does not return the error ResourceNotFoundException in order to correctly handle retries.

RecoveryWindowInDays => Int

(Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager can delete the secret. You can't use both this parameter and the ForceDeleteWithoutRecovery parameter in the same API call.

This value can range from 7 to 30 days with a default value of 30.

REQUIRED SecretId => Str

Specifies the secret to delete. 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 DeleteSecret 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