« blib/lib/Paws/SecretsManager/ReplicaRegionType.pm
↑ Summary
blib/lib/Paws/SecretsManager/ReplicateSecretToRegionsResponse.pm »
| 1 | |||
| 2 | package Paws::SecretsManager::ReplicateSecretToRegions; | ||
| 3 | use Moose; | ||
| 4 | has AddReplicaRegions => (is => 'ro', isa => 'ArrayRef[Paws::SecretsManager::ReplicaRegionType]', required => 1); | ||
| 5 | has ForceOverwriteReplicaSecret => (is => 'ro', isa => 'Bool'); | ||
| 6 | has SecretId => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ReplicateSecretToRegions'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SecretsManager::ReplicateSecretToRegionsResponse'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::SecretsManager::ReplicateSecretToRegions - Arguments for method ReplicateSecretToRegions on L<Paws::SecretsManager> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method ReplicateSecretToRegions on the | ||
| 24 | L<AWS Secrets Manager|Paws::SecretsManager> service. Use the attributes of this class | ||
| 25 | as arguments to method ReplicateSecretToRegions. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ReplicateSecretToRegions. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $secretsmanager = Paws->service('SecretsManager'); | ||
| 32 | my $ReplicateSecretToRegionsResponse = | ||
| 33 | $secretsmanager->ReplicateSecretToRegions( | ||
| 34 | AddReplicaRegions => [ | ||
| 35 | { | ||
| 36 | KmsKeyId => 'MyKmsKeyIdType', # max: 2048; OPTIONAL | ||
| 37 | Region => 'MyRegionType', # min: 1, max: 128; OPTIONAL | ||
| 38 | }, | ||
| 39 | ... | ||
| 40 | ], | ||
| 41 | SecretId => 'MySecretIdType', | ||
| 42 | ForceOverwriteReplicaSecret => 1, # OPTIONAL | ||
| 43 | ); | ||
| 44 | |||
| 45 | # Results: | ||
| 46 | my $ARN = $ReplicateSecretToRegionsResponse->ARN; | ||
| 47 | my $ReplicationStatus = | ||
| 48 | $ReplicateSecretToRegionsResponse->ReplicationStatus; | ||
| 49 | |||
| 50 | # Returns a L<Paws::SecretsManager::ReplicateSecretToRegionsResponse> object. | ||
| 51 | |||
| 52 | 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. | ||
| 53 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/secretsmanager/ReplicateSecretToRegions> | ||
| 54 | |||
| 55 | =head1 ATTRIBUTES | ||
| 56 | |||
| 57 | |||
| 58 | =head2 B<REQUIRED> AddReplicaRegions => ArrayRef[L<Paws::SecretsManager::ReplicaRegionType>] | ||
| 59 | |||
| 60 | Add Regions to replicate the secret. | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head2 ForceOverwriteReplicaSecret => Bool | ||
| 65 | |||
| 66 | (Optional) If set, Secrets Manager replication overwrites a secret with | ||
| 67 | the same name in the destination region. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head2 B<REQUIRED> SecretId => Str | ||
| 72 | |||
| 73 | Use the C<Secret Id> to replicate a secret to regions. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head1 SEE ALSO | ||
| 79 | |||
| 80 | This class forms part of L<Paws>, documenting arguments for method ReplicateSecretToRegions in L<Paws::SecretsManager> | ||
| 81 | |||
| 82 | =head1 BUGS and CONTRIBUTIONS | ||
| 83 | |||
| 84 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 85 | |||
| 86 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 87 | |||
| 88 | =cut | ||
| 89 |