« blib/lib/Paws/RedShift/CreateClusterSecurityGroupResult.pm
↑ Summary
blib/lib/Paws/RedShift/CreateClusterSnapshotResult.pm »
| 1 | |||
| 2 | package Paws::RedShift::CreateClusterSnapshot; | ||
| 3 | 1 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 1 | has ClusterIdentifier => (is => 'ro', isa => 'Str', required => 1); | |
| 5 | 1 | has ManualSnapshotRetentionPeriod => (is => 'ro', isa => 'Int'); | |
| 6 | 1 | has SnapshotIdentifier => (is => 'ro', isa => 'Str', required => 1); | |
| 7 | 1 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::RedShift::Tag]'); | |
| 8 | |||
| 9 | 1 | ▶ | use MooseX::ClassAttribute; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 10 | |||
| 11 | 1 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateClusterSnapshot'); | |
| 12 | 1 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RedShift::CreateClusterSnapshotResult'); | |
| 13 | 1 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'CreateClusterSnapshotResult'); | |
| 14 | 1 | 1; | |
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::RedShift::CreateClusterSnapshot - Arguments for method CreateClusterSnapshot on L<Paws::RedShift> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method CreateClusterSnapshot on the | ||
| 25 | L<Amazon Redshift|Paws::RedShift> service. Use the attributes of this class | ||
| 26 | as arguments to method CreateClusterSnapshot. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateClusterSnapshot. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $redshift = Paws->service('RedShift'); | ||
| 33 | my $CreateClusterSnapshotResult = $redshift->CreateClusterSnapshot( | ||
| 34 | ClusterIdentifier => 'MyString', | ||
| 35 | SnapshotIdentifier => 'MyString', | ||
| 36 | ManualSnapshotRetentionPeriod => 1, # OPTIONAL | ||
| 37 | Tags => [ | ||
| 38 | { | ||
| 39 | Key => 'MyString', # max: 2147483647 | ||
| 40 | Value => 'MyString', # max: 2147483647 | ||
| 41 | }, | ||
| 42 | ... | ||
| 43 | ], # OPTIONAL | ||
| 44 | ); | ||
| 45 | |||
| 46 | # Results: | ||
| 47 | my $Snapshot = $CreateClusterSnapshotResult->Snapshot; | ||
| 48 | |||
| 49 | # Returns a L<Paws::RedShift::CreateClusterSnapshotResult> object. | ||
| 50 | |||
| 51 | 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. | ||
| 52 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/redshift/CreateClusterSnapshot> | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 B<REQUIRED> ClusterIdentifier => Str | ||
| 58 | |||
| 59 | The cluster identifier for which you want a snapshot. | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | =head2 ManualSnapshotRetentionPeriod => Int | ||
| 64 | |||
| 65 | The number of days that a manual snapshot is retained. If the value is | ||
| 66 | -1, the manual snapshot is retained indefinitely. | ||
| 67 | |||
| 68 | The value must be either -1 or an integer between 1 and 3,653. | ||
| 69 | |||
| 70 | The default value is -1. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 B<REQUIRED> SnapshotIdentifier => Str | ||
| 75 | |||
| 76 | A unique identifier for the snapshot that you are requesting. This | ||
| 77 | identifier must be unique for all snapshots within the AWS account. | ||
| 78 | |||
| 79 | Constraints: | ||
| 80 | |||
| 81 | =over | ||
| 82 | |||
| 83 | =item * | ||
| 84 | |||
| 85 | Cannot be null, empty, or blank | ||
| 86 | |||
| 87 | =item * | ||
| 88 | |||
| 89 | Must contain from 1 to 255 alphanumeric characters or hyphens | ||
| 90 | |||
| 91 | =item * | ||
| 92 | |||
| 93 | First character must be a letter | ||
| 94 | |||
| 95 | =item * | ||
| 96 | |||
| 97 | Cannot end with a hyphen or contain two consecutive hyphens | ||
| 98 | |||
| 99 | =back | ||
| 100 | |||
| 101 | Example: C<my-snapshot-id> | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head2 Tags => ArrayRef[L<Paws::RedShift::Tag>] | ||
| 106 | |||
| 107 | A list of tag instances. | ||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head1 SEE ALSO | ||
| 113 | |||
| 114 | This class forms part of L<Paws>, documenting arguments for method CreateClusterSnapshot in L<Paws::RedShift> | ||
| 115 | |||
| 116 | =head1 BUGS and CONTRIBUTIONS | ||
| 117 | |||
| 118 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 119 | |||
| 120 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 121 | |||
| 122 | =cut | ||
| 123 | |||