« blib/lib/Paws/RedShift/EnableLogging.pm
↑ Summary
blib/lib/Paws/RedShift/EnableSnapshotCopyResult.pm »
| 1 | |||
| 2 | package Paws::RedShift::EnableSnapshotCopy; | ||
| 3 | use Moose; | ||
| 4 | has ClusterIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has DestinationRegion => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has ManualSnapshotRetentionPeriod => (is => 'ro', isa => 'Int'); | ||
| 7 | has RetentionPeriod => (is => 'ro', isa => 'Int'); | ||
| 8 | has SnapshotCopyGrantName => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'EnableSnapshotCopy'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RedShift::EnableSnapshotCopyResult'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'EnableSnapshotCopyResult'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::RedShift::EnableSnapshotCopy - Arguments for method EnableSnapshotCopy on L<Paws::RedShift> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method EnableSnapshotCopy on the | ||
| 26 | L<Amazon Redshift|Paws::RedShift> service. Use the attributes of this class | ||
| 27 | as arguments to method EnableSnapshotCopy. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to EnableSnapshotCopy. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $redshift = Paws->service('RedShift'); | ||
| 34 | my $EnableSnapshotCopyResult = $redshift->EnableSnapshotCopy( | ||
| 35 | ClusterIdentifier => 'MyString', | ||
| 36 | DestinationRegion => 'MyString', | ||
| 37 | ManualSnapshotRetentionPeriod => 1, # OPTIONAL | ||
| 38 | RetentionPeriod => 1, # OPTIONAL | ||
| 39 | SnapshotCopyGrantName => 'MyString', # OPTIONAL | ||
| 40 | ); | ||
| 41 | |||
| 42 | # Results: | ||
| 43 | my $Cluster = $EnableSnapshotCopyResult->Cluster; | ||
| 44 | |||
| 45 | # Returns a L<Paws::RedShift::EnableSnapshotCopyResult> object. | ||
| 46 | |||
| 47 | 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. | ||
| 48 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/redshift/EnableSnapshotCopy> | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 B<REQUIRED> ClusterIdentifier => Str | ||
| 54 | |||
| 55 | The unique identifier of the source cluster to copy snapshots from. | ||
| 56 | |||
| 57 | Constraints: Must be the valid name of an existing cluster that does | ||
| 58 | not already have cross-region snapshot copy enabled. | ||
| 59 | |||
| 60 | |||
| 61 | |||
| 62 | =head2 B<REQUIRED> DestinationRegion => Str | ||
| 63 | |||
| 64 | The destination AWS Region that you want to copy snapshots to. | ||
| 65 | |||
| 66 | Constraints: Must be the name of a valid AWS Region. For more | ||
| 67 | information, see Regions and Endpoints | ||
| 68 | (https://docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region) | ||
| 69 | in the Amazon Web Services General Reference. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 ManualSnapshotRetentionPeriod => Int | ||
| 74 | |||
| 75 | The number of days to retain newly copied snapshots in the destination | ||
| 76 | AWS Region after they are copied from the source AWS Region. If the | ||
| 77 | value is -1, the manual snapshot is retained indefinitely. | ||
| 78 | |||
| 79 | The value must be either -1 or an integer between 1 and 3,653. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head2 RetentionPeriod => Int | ||
| 84 | |||
| 85 | The number of days to retain automated snapshots in the destination | ||
| 86 | region after they are copied from the source region. | ||
| 87 | |||
| 88 | Default: 7. | ||
| 89 | |||
| 90 | Constraints: Must be at least 1 and no more than 35. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 SnapshotCopyGrantName => Str | ||
| 95 | |||
| 96 | The name of the snapshot copy grant to use when snapshots of an AWS | ||
| 97 | KMS-encrypted cluster are copied to the destination region. | ||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | =head1 SEE ALSO | ||
| 103 | |||
| 104 | This class forms part of L<Paws>, documenting arguments for method EnableSnapshotCopy in L<Paws::RedShift> | ||
| 105 | |||
| 106 | =head1 BUGS and CONTRIBUTIONS | ||
| 107 | |||
| 108 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 109 | |||
| 110 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 111 | |||
| 112 | =cut | ||
| 113 |