« blib/lib/Paws/RedShift/ModifyClusterResult.pm
↑ Summary
blib/lib/Paws/RedShift/ModifyClusterSnapshotResult.pm »
| 1 | |||
| 2 | package Paws::RedShift::ModifyClusterSnapshot; | ||
| 3 | use Moose; | ||
| 4 | has Force => (is => 'ro', isa => 'Bool'); | ||
| 5 | has ManualSnapshotRetentionPeriod => (is => 'ro', isa => 'Int'); | ||
| 6 | has SnapshotIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ModifyClusterSnapshot'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RedShift::ModifyClusterSnapshotResult'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'ModifyClusterSnapshotResult'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::RedShift::ModifyClusterSnapshot - Arguments for method ModifyClusterSnapshot on L<Paws::RedShift> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method ModifyClusterSnapshot on the | ||
| 24 | L<Amazon Redshift|Paws::RedShift> service. Use the attributes of this class | ||
| 25 | as arguments to method ModifyClusterSnapshot. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ModifyClusterSnapshot. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $redshift = Paws->service('RedShift'); | ||
| 32 | my $ModifyClusterSnapshotResult = $redshift->ModifyClusterSnapshot( | ||
| 33 | SnapshotIdentifier => 'MyString', | ||
| 34 | Force => 1, # OPTIONAL | ||
| 35 | ManualSnapshotRetentionPeriod => 1, # OPTIONAL | ||
| 36 | ); | ||
| 37 | |||
| 38 | # Results: | ||
| 39 | my $Snapshot = $ModifyClusterSnapshotResult->Snapshot; | ||
| 40 | |||
| 41 | # Returns a L<Paws::RedShift::ModifyClusterSnapshotResult> object. | ||
| 42 | |||
| 43 | 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. | ||
| 44 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/redshift/ModifyClusterSnapshot> | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 Force => Bool | ||
| 50 | |||
| 51 | A Boolean option to override an exception if the retention period has | ||
| 52 | already passed. | ||
| 53 | |||
| 54 | |||
| 55 | |||
| 56 | =head2 ManualSnapshotRetentionPeriod => Int | ||
| 57 | |||
| 58 | The number of days that a manual snapshot is retained. If the value is | ||
| 59 | -1, the manual snapshot is retained indefinitely. | ||
| 60 | |||
| 61 | If the manual snapshot falls outside of the new retention period, you | ||
| 62 | can specify the force option to immediately delete the snapshot. | ||
| 63 | |||
| 64 | The value must be either -1 or an integer between 1 and 3,653. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 B<REQUIRED> SnapshotIdentifier => Str | ||
| 69 | |||
| 70 | The identifier of the snapshot whose setting you want to modify. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head1 SEE ALSO | ||
| 76 | |||
| 77 | This class forms part of L<Paws>, documenting arguments for method ModifyClusterSnapshot in L<Paws::RedShift> | ||
| 78 | |||
| 79 | =head1 BUGS and CONTRIBUTIONS | ||
| 80 | |||
| 81 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 82 | |||
| 83 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 84 | |||
| 85 | =cut | ||
| 86 |