« blib/lib/Paws/SecretsManager/CreateSecretResponse.pm
↑ Summary
blib/lib/Paws/SecretsManager/DeleteResourcePolicyResponse.pm »
| 1 | |||
| 2 | package Paws::SecretsManager::DeleteResourcePolicy; | ||
| 3 | use Moose; | ||
| 4 | has SecretId => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | |||
| 6 | use MooseX::ClassAttribute; | ||
| 7 | |||
| 8 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DeleteResourcePolicy'); | ||
| 9 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SecretsManager::DeleteResourcePolicyResponse'); | ||
| 10 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::SecretsManager::DeleteResourcePolicy - Arguments for method DeleteResourcePolicy on L<Paws::SecretsManager> | ||
| 18 | |||
| 19 | =head1 DESCRIPTION | ||
| 20 | |||
| 21 | This class represents the parameters used for calling the method DeleteResourcePolicy on the | ||
| 22 | L<AWS Secrets Manager|Paws::SecretsManager> service. Use the attributes of this class | ||
| 23 | as arguments to method DeleteResourcePolicy. | ||
| 24 | |||
| 25 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DeleteResourcePolicy. | ||
| 26 | |||
| 27 | =head1 SYNOPSIS | ||
| 28 | |||
| 29 | my $secretsmanager = Paws->service('SecretsManager'); | ||
| 30 | # To delete the resource-based policy attached to a secret | ||
| 31 | # The following example shows how to delete the resource-based policy that is | ||
| 32 | # attached to a secret. | ||
| 33 | my $DeleteResourcePolicyResponse = $secretsmanager->DeleteResourcePolicy( | ||
| 34 | 'SecretId' => 'MyTestDatabaseSecret' ); | ||
| 35 | |||
| 36 | # Results: | ||
| 37 | my $ARN = $DeleteResourcePolicyResponse->ARN; | ||
| 38 | my $Name = $DeleteResourcePolicyResponse->Name; | ||
| 39 | |||
| 40 | # Returns a L<Paws::SecretsManager::DeleteResourcePolicyResponse> object. | ||
| 41 | |||
| 42 | 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. | ||
| 43 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/secretsmanager/DeleteResourcePolicy> | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 B<REQUIRED> SecretId => Str | ||
| 49 | |||
| 50 | Specifies the secret that you want to delete the attached | ||
| 51 | resource-based policy for. You can specify either the Amazon Resource | ||
| 52 | Name (ARN) or the friendly name of the secret. | ||
| 53 | |||
| 54 | If you specify an ARN, we generally recommend that you specify a | ||
| 55 | complete ARN. You can specify a partial ARN tooE<mdash>for example, if | ||
| 56 | you donE<rsquo>t include the final hyphen and six random characters | ||
| 57 | that Secrets Manager adds at the end of the ARN when you created the | ||
| 58 | secret. A partial ARN match can work as long as it uniquely matches | ||
| 59 | only one secret. However, if your secret has a name that ends in a | ||
| 60 | hyphen followed by six characters (before Secrets Manager adds the | ||
| 61 | hyphen and six characters to the ARN) and you try to use that as a | ||
| 62 | partial ARN, then those characters cause Secrets Manager to assume that | ||
| 63 | youE<rsquo>re specifying a complete ARN. This confusion can cause | ||
| 64 | unexpected results. To avoid this situation, we recommend that you | ||
| 65 | donE<rsquo>t create secret names ending with a hyphen followed by six | ||
| 66 | characters. | ||
| 67 | |||
| 68 | If you specify an incomplete ARN without the random suffix, and instead | ||
| 69 | provide the 'friendly name', you I<must> not include the random suffix. | ||
| 70 | If you do include the random suffix added by Secrets Manager, you | ||
| 71 | receive either a I<ResourceNotFoundException> or an | ||
| 72 | I<AccessDeniedException> error, depending on your permissions. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head1 SEE ALSO | ||
| 78 | |||
| 79 | This class forms part of L<Paws>, documenting arguments for method DeleteResourcePolicy in L<Paws::SecretsManager> | ||
| 80 | |||
| 81 | =head1 BUGS and CONTRIBUTIONS | ||
| 82 | |||
| 83 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 84 | |||
| 85 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 86 | |||
| 87 | =cut | ||
| 88 |