« blib/lib/Paws/RedShift/DeferredMaintenanceWindow.pm
↑ Summary
blib/lib/Paws/RedShift/DeleteClusterParameterGroup.pm »
| 1 | |||
| 2 | package Paws::RedShift::DeleteCluster; | ||
| 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 FinalClusterSnapshotIdentifier => (is => 'ro', isa => 'Str'); | |
| 6 | 1 | has FinalClusterSnapshotRetentionPeriod => (is => 'ro', isa => 'Int'); | |
| 7 | 1 | has SkipFinalClusterSnapshot => (is => 'ro', isa => 'Bool'); | |
| 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 => 'DeleteCluster'); | |
| 12 | 1 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RedShift::DeleteClusterResult'); | |
| 13 | 1 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'DeleteClusterResult'); | |
| 14 | 1 | 1; | |
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::RedShift::DeleteCluster - Arguments for method DeleteCluster on L<Paws::RedShift> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method DeleteCluster on the | ||
| 25 | L<Amazon Redshift|Paws::RedShift> service. Use the attributes of this class | ||
| 26 | as arguments to method DeleteCluster. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DeleteCluster. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $redshift = Paws->service('RedShift'); | ||
| 33 | my $DeleteClusterResult = $redshift->DeleteCluster( | ||
| 34 | ClusterIdentifier => 'MyString', | ||
| 35 | FinalClusterSnapshotIdentifier => 'MyString', # OPTIONAL | ||
| 36 | FinalClusterSnapshotRetentionPeriod => 1, # OPTIONAL | ||
| 37 | SkipFinalClusterSnapshot => 1, # OPTIONAL | ||
| 38 | ); | ||
| 39 | |||
| 40 | # Results: | ||
| 41 | my $Cluster = $DeleteClusterResult->Cluster; | ||
| 42 | |||
| 43 | # Returns a L<Paws::RedShift::DeleteClusterResult> object. | ||
| 44 | |||
| 45 | 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. | ||
| 46 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/redshift/DeleteCluster> | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 B<REQUIRED> ClusterIdentifier => Str | ||
| 52 | |||
| 53 | The identifier of the cluster to be deleted. | ||
| 54 | |||
| 55 | Constraints: | ||
| 56 | |||
| 57 | =over | ||
| 58 | |||
| 59 | =item * | ||
| 60 | |||
| 61 | Must contain lowercase characters. | ||
| 62 | |||
| 63 | =item * | ||
| 64 | |||
| 65 | Must contain from 1 to 63 alphanumeric characters or hyphens. | ||
| 66 | |||
| 67 | =item * | ||
| 68 | |||
| 69 | First character must be a letter. | ||
| 70 | |||
| 71 | =item * | ||
| 72 | |||
| 73 | Cannot end with a hyphen or contain two consecutive hyphens. | ||
| 74 | |||
| 75 | =back | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head2 FinalClusterSnapshotIdentifier => Str | ||
| 81 | |||
| 82 | The identifier of the final snapshot that is to be created immediately | ||
| 83 | before deleting the cluster. If this parameter is provided, | ||
| 84 | I<SkipFinalClusterSnapshot> must be C<false>. | ||
| 85 | |||
| 86 | Constraints: | ||
| 87 | |||
| 88 | =over | ||
| 89 | |||
| 90 | =item * | ||
| 91 | |||
| 92 | Must be 1 to 255 alphanumeric characters. | ||
| 93 | |||
| 94 | =item * | ||
| 95 | |||
| 96 | First character must be a letter. | ||
| 97 | |||
| 98 | =item * | ||
| 99 | |||
| 100 | Cannot end with a hyphen or contain two consecutive hyphens. | ||
| 101 | |||
| 102 | =back | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | =head2 FinalClusterSnapshotRetentionPeriod => Int | ||
| 108 | |||
| 109 | The number of days that a manual snapshot is retained. If the value is | ||
| 110 | -1, the manual snapshot is retained indefinitely. | ||
| 111 | |||
| 112 | The value must be either -1 or an integer between 1 and 3,653. | ||
| 113 | |||
| 114 | The default value is -1. | ||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | =head2 SkipFinalClusterSnapshot => Bool | ||
| 119 | |||
| 120 | Determines whether a final snapshot of the cluster is created before | ||
| 121 | Amazon Redshift deletes the cluster. If C<true>, a final cluster | ||
| 122 | snapshot is not created. If C<false>, a final cluster snapshot is | ||
| 123 | created before the cluster is deleted. | ||
| 124 | |||
| 125 | The I<FinalClusterSnapshotIdentifier> parameter must be specified if | ||
| 126 | I<SkipFinalClusterSnapshot> is C<false>. | ||
| 127 | |||
| 128 | Default: C<false> | ||
| 129 | |||
| 130 | |||
| 131 | |||
| 132 | |||
| 133 | =head1 SEE ALSO | ||
| 134 | |||
| 135 | This class forms part of L<Paws>, documenting arguments for method DeleteCluster in L<Paws::RedShift> | ||
| 136 | |||
| 137 | =head1 BUGS and CONTRIBUTIONS | ||
| 138 | |||
| 139 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 140 | |||
| 141 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 142 | |||
| 143 | =cut | ||
| 144 | |||