File Coverage

blib/lib/Paws/RDS/DeleteDBCluster.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


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