blib/lib/Paws/SecretsManager/CancelRotateSecret.pm untested

filter: Statementstmt 0.0% 0 / 10 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 12 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::SecretsManager::CancelRotateSecret;
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 => 'CancelRotateSecret');
9 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SecretsManager::CancelRotateSecretResponse');
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::CancelRotateSecret - Arguments for method CancelRotateSecret on L<Paws::SecretsManager>
18  
19 =head1 DESCRIPTION
20  
21 This class represents the parameters used for calling the method CancelRotateSecret on the
22 L<AWS Secrets Manager|Paws::SecretsManager> service. Use the attributes of this class
23 as arguments to method CancelRotateSecret.
24  
25 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CancelRotateSecret.
26  
27 =head1 SYNOPSIS
28  
29 my $secretsmanager = Paws->service('SecretsManager');
30 # To cancel scheduled rotation for a secret
31 # The following example shows how to cancel rotation for a secret. The operation
32 # sets the RotationEnabled field to false and cancels all scheduled rotations.
33 # To resume scheduled rotations, you must re-enable rotation by calling the
34 # rotate-secret operation.
35 my $CancelRotateSecretResponse = $secretsmanager->CancelRotateSecret(
36 'SecretId' => 'MyTestDatabaseSecret' );
37  
38 # Results:
39 my $ARN = $CancelRotateSecretResponse->ARN;
40 my $Name = $CancelRotateSecretResponse->Name;
41  
42 # Returns a L<Paws::SecretsManager::CancelRotateSecretResponse> object.
43  
44 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.
45 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/secretsmanager/CancelRotateSecret>
46  
47 =head1 ATTRIBUTES
48  
49  
50 =head2 B<REQUIRED> SecretId => Str
51  
52 Specifies the secret to cancel a rotation request. You can specify
53 either the Amazon Resource Name (ARN) or the friendly name of the
54 secret.
55  
56 If you specify an ARN, we generally recommend that you specify a
57 complete ARN. You can specify a partial ARN tooE<mdash>for example, if
58 you donE<rsquo>t include the final hyphen and six random characters
59 that Secrets Manager adds at the end of the ARN when you created the
60 secret. A partial ARN match can work as long as it uniquely matches
61 only one secret. However, if your secret has a name that ends in a
62 hyphen followed by six characters (before Secrets Manager adds the
63 hyphen and six characters to the ARN) and you try to use that as a
64 partial ARN, then those characters cause Secrets Manager to assume that
65 youE<rsquo>re specifying a complete ARN. This confusion can cause
66 unexpected results. To avoid this situation, we recommend that you
67 donE<rsquo>t create secret names ending with a hyphen followed by six
68 characters.
69  
70 If you specify an incomplete ARN without the random suffix, and instead
71 provide the 'friendly name', you I<must> not include the random suffix.
72 If you do include the random suffix added by Secrets Manager, you
73 receive either a I<ResourceNotFoundException> or an
74 I<AccessDeniedException> error, depending on your permissions.
75  
76  
77  
78  
79 =head1 SEE ALSO
80  
81 This class forms part of L<Paws>, documenting arguments for method CancelRotateSecret in L<Paws::SecretsManager>
82  
83 =head1 BUGS and CONTRIBUTIONS
84  
85 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
86  
87 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
88  
89 =cut
90