File Coverage

blib/lib/Paws/RedShift/DeleteCluster.pm
Criterion Covered Total %
statement 12 12 100.0
branch n/a
condition n/a
subroutine 4 4 100.0
pod n/a
total 16 16 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::RedShift::DeleteCluster;
3 1     1   276 use Moose;
  1     1   3  
  1         5  
  1         678  
  1         2  
  1         11  
4             has ClusterIdentifier => (is => 'ro', isa => 'Str', required => 1);
5             has FinalClusterSnapshotIdentifier => (is => 'ro', isa => 'Str');
6             has SkipFinalClusterSnapshot => (is => 'ro', isa => 'Bool');
7              
8 1     1   5314 use MooseX::ClassAttribute;
  1     1   2  
  1         7  
  1         8029  
  1         7  
  1         17  
9              
10             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DeleteCluster');
11             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RedShift::DeleteClusterResult');
12             class_has _result_key => (isa => 'Str', is => 'ro', default => 'DeleteClusterResult');
13             1;
14              
15             ### main pod documentation begin ###
16              
17             =head1 NAME
18              
19             Paws::RedShift::DeleteCluster - Arguments for method DeleteCluster on Paws::RedShift
20              
21             =head1 DESCRIPTION
22              
23             This class represents the parameters used for calling the method DeleteCluster on the
24             Amazon Redshift service. Use the attributes of this class
25             as arguments to method DeleteCluster.
26              
27             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DeleteCluster.
28              
29             As an example:
30              
31             $service_obj->DeleteCluster(Att1 => $value1, Att2 => $value2, ...);
32              
33             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.
34              
35             =head1 ATTRIBUTES
36              
37              
38             =head2 B<REQUIRED> ClusterIdentifier => Str
39              
40             The identifier of the cluster to be deleted.
41              
42             Constraints:
43              
44             =over
45              
46             =item *
47              
48             Must contain lowercase characters.
49              
50             =item *
51              
52             Must contain from 1 to 63 alphanumeric characters or hyphens.
53              
54             =item *
55              
56             First character must be a letter.
57              
58             =item *
59              
60             Cannot end with a hyphen or contain two consecutive hyphens.
61              
62             =back
63              
64              
65              
66              
67             =head2 FinalClusterSnapshotIdentifier => Str
68              
69             The identifier of the final snapshot that is to be created immediately
70             before deleting the cluster. If this parameter is provided,
71             I<SkipFinalClusterSnapshot> must be C<false>.
72              
73             Constraints:
74              
75             =over
76              
77             =item *
78              
79             Must be 1 to 255 alphanumeric characters.
80              
81             =item *
82              
83             First character must be a letter.
84              
85             =item *
86              
87             Cannot end with a hyphen or contain two consecutive hyphens.
88              
89             =back
90              
91              
92              
93              
94             =head2 SkipFinalClusterSnapshot => Bool
95              
96             Determines whether a final snapshot of the cluster is created before
97             Amazon Redshift deletes the cluster. If C<true>, a final cluster
98             snapshot is not created. If C<false>, a final cluster snapshot is
99             created before the cluster is deleted.
100              
101             The I<FinalClusterSnapshotIdentifier> parameter must be specified if
102             I<SkipFinalClusterSnapshot> is C<false>.
103              
104             Default: C<false>
105              
106              
107              
108              
109             =head1 SEE ALSO
110              
111             This class forms part of L<Paws>, documenting arguments for method DeleteCluster in L<Paws::RedShift>
112              
113             =head1 BUGS and CONTRIBUTIONS
114              
115             The source code is located here: https://github.com/pplu/aws-sdk-perl
116              
117             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
118              
119             =cut
120