« blib/lib/Paws/SecretsManager/RotationRulesType.pm
↑ Summary
blib/lib/Paws/SecretsManager/SecretVersionsListEntry.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SecretsManager::SecretListEntry; | ||
| 3 | use Moose; | ||
| 4 | has ARN => (is => 'ro', isa => 'Str'); | ||
| 5 | has CreatedDate => (is => 'ro', isa => 'Str'); | ||
| 6 | has DeletedDate => (is => 'ro', isa => 'Str'); | ||
| 7 | has Description => (is => 'ro', isa => 'Str'); | ||
| 8 | has KmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 9 | has LastAccessedDate => (is => 'ro', isa => 'Str'); | ||
| 10 | has LastChangedDate => (is => 'ro', isa => 'Str'); | ||
| 11 | has LastRotatedDate => (is => 'ro', isa => 'Str'); | ||
| 12 | has Name => (is => 'ro', isa => 'Str'); | ||
| 13 | has OwningService => (is => 'ro', isa => 'Str'); | ||
| 14 | has PrimaryRegion => (is => 'ro', isa => 'Str'); | ||
| 15 | has RotationEnabled => (is => 'ro', isa => 'Bool'); | ||
| 16 | has RotationLambdaARN => (is => 'ro', isa => 'Str'); | ||
| 17 | has RotationRules => (is => 'ro', isa => 'Paws::SecretsManager::RotationRulesType'); | ||
| 18 | has SecretVersionsToStages => (is => 'ro', isa => 'Paws::SecretsManager::SecretVersionsToStagesMapType'); | ||
| 19 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::SecretsManager::Tag]'); | ||
| 20 | |||
| 21 | 1; | ||
| 22 | |||
| 23 | ### main pod documentation begin ### | ||
| 24 | |||
| 25 | =head1 NAME | ||
| 26 | |||
| 27 | Paws::SecretsManager::SecretListEntry | ||
| 28 | |||
| 29 | =head1 USAGE | ||
| 30 | |||
| 31 | This class represents one of two things: | ||
| 32 | |||
| 33 | =head3 Arguments in a call to a service | ||
| 34 | |||
| 35 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 36 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 37 | |||
| 38 | As an example, if Att1 is expected to be a Paws::SecretsManager::SecretListEntry object: | ||
| 39 | |||
| 40 | $service_obj->Method(Att1 => { ARN => $value, ..., Tags => $value }); | ||
| 41 | |||
| 42 | =head3 Results returned from an API call | ||
| 43 | |||
| 44 | Use accessors for each attribute. If Att1 is expected to be an Paws::SecretsManager::SecretListEntry object: | ||
| 45 | |||
| 46 | $result = $service_obj->Method(...); | ||
| 47 | $result->Att1->ARN | ||
| 48 | |||
| 49 | =head1 DESCRIPTION | ||
| 50 | |||
| 51 | A structure that contains the details about a secret. It does not | ||
| 52 | include the encrypted C<SecretString> and C<SecretBinary> values. To | ||
| 53 | get those values, use the GetSecretValue operation. | ||
| 54 | |||
| 55 | =head1 ATTRIBUTES | ||
| 56 | |||
| 57 | |||
| 58 | =head2 ARN => Str | ||
| 59 | |||
| 60 | The Amazon Resource Name (ARN) of the secret. | ||
| 61 | |||
| 62 | For more information about ARNs in Secrets Manager, see Policy | ||
| 63 | Resources | ||
| 64 | (https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#iam-resources) | ||
| 65 | in the I<AWS Secrets Manager User Guide>. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 CreatedDate => Str | ||
| 69 | |||
| 70 | The date and time when a secret was created. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 DeletedDate => Str | ||
| 74 | |||
| 75 | The date and time the deletion of the secret occurred. Not present on | ||
| 76 | active secrets. The secret can be recovered until the number of days in | ||
| 77 | the recovery window has passed, as specified in the | ||
| 78 | C<RecoveryWindowInDays> parameter of the DeleteSecret operation. | ||
| 79 | |||
| 80 | |||
| 81 | =head2 Description => Str | ||
| 82 | |||
| 83 | The user-provided description of the secret. | ||
| 84 | |||
| 85 | |||
| 86 | =head2 KmsKeyId => Str | ||
| 87 | |||
| 88 | The ARN or alias of the AWS KMS customer master key (CMK) used to | ||
| 89 | encrypt the C<SecretString> and C<SecretBinary> fields in each version | ||
| 90 | of the secret. If you don't provide a key, then Secrets Manager | ||
| 91 | defaults to encrypting the secret fields with the default KMS CMK, the | ||
| 92 | key named C<awssecretsmanager>, for this account. | ||
| 93 | |||
| 94 | |||
| 95 | =head2 LastAccessedDate => Str | ||
| 96 | |||
| 97 | The last date that this secret was accessed. This value is truncated to | ||
| 98 | midnight of the date and therefore shows only the date, not the time. | ||
| 99 | |||
| 100 | |||
| 101 | =head2 LastChangedDate => Str | ||
| 102 | |||
| 103 | The last date and time that this secret was modified in any way. | ||
| 104 | |||
| 105 | |||
| 106 | =head2 LastRotatedDate => Str | ||
| 107 | |||
| 108 | The most recent date and time that the Secrets Manager rotation process | ||
| 109 | was successfully completed. This value is null if the secret hasn't | ||
| 110 | ever rotated. | ||
| 111 | |||
| 112 | |||
| 113 | =head2 Name => Str | ||
| 114 | |||
| 115 | The friendly name of the secret. You can use forward slashes in the | ||
| 116 | name to represent a path hierarchy. For example, | ||
| 117 | C</prod/databases/dbserver1> could represent the secret for a server | ||
| 118 | named C<dbserver1> in the folder C<databases> in the folder C<prod>. | ||
| 119 | |||
| 120 | |||
| 121 | =head2 OwningService => Str | ||
| 122 | |||
| 123 | Returns the name of the service that created the secret. | ||
| 124 | |||
| 125 | |||
| 126 | =head2 PrimaryRegion => Str | ||
| 127 | |||
| 128 | The Region where Secrets Manager originated the secret. | ||
| 129 | |||
| 130 | |||
| 131 | =head2 RotationEnabled => Bool | ||
| 132 | |||
| 133 | Indicates whether automatic, scheduled rotation is enabled for this | ||
| 134 | secret. | ||
| 135 | |||
| 136 | |||
| 137 | =head2 RotationLambdaARN => Str | ||
| 138 | |||
| 139 | The ARN of an AWS Lambda function invoked by Secrets Manager to rotate | ||
| 140 | and expire the secret either automatically per the schedule or manually | ||
| 141 | by a call to RotateSecret. | ||
| 142 | |||
| 143 | |||
| 144 | =head2 RotationRules => L<Paws::SecretsManager::RotationRulesType> | ||
| 145 | |||
| 146 | A structure that defines the rotation configuration for the secret. | ||
| 147 | |||
| 148 | |||
| 149 | =head2 SecretVersionsToStages => L<Paws::SecretsManager::SecretVersionsToStagesMapType> | ||
| 150 | |||
| 151 | A list of all of the currently assigned C<SecretVersionStage> staging | ||
| 152 | labels and the C<SecretVersionId> attached to each one. Staging labels | ||
| 153 | are used to keep track of the different versions during the rotation | ||
| 154 | process. | ||
| 155 | |||
| 156 | A version that does not have any C<SecretVersionStage> is considered | ||
| 157 | deprecated and subject to deletion. Such versions are not included in | ||
| 158 | this list. | ||
| 159 | |||
| 160 | |||
| 161 | =head2 Tags => ArrayRef[L<Paws::SecretsManager::Tag>] | ||
| 162 | |||
| 163 | The list of user-defined tags associated with the secret. To add tags | ||
| 164 | to a secret, use TagResource. To remove tags, use UntagResource. | ||
| 165 | |||
| 166 | |||
| 167 | |||
| 168 | =head1 SEE ALSO | ||
| 169 | |||
| 170 | This class forms part of L<Paws>, describing an object used in L<Paws::SecretsManager> | ||
| 171 | |||
| 172 | =head1 BUGS and CONTRIBUTIONS | ||
| 173 | |||
| 174 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 175 | |||
| 176 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 177 | |||
| 178 | =cut | ||
| 179 |