File Coverage

blib/lib/Paws/RDS/DeleteDBInstance.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	sub	time	code
1
2				package Paws::RDS::DeleteDBInstance;
3	1	1	671	use Moose;
	1		4
	1		9
4				has DBInstanceIdentifier => (is => 'ro', isa => 'Str', required => 1);
5				has FinalDBSnapshotIdentifier => (is => 'ro', isa => 'Str');
6				has SkipFinalSnapshot => (is => 'ro', isa => 'Bool');
7
8	1	1	7609	use MooseX::ClassAttribute;
	1		3
	1		11
9
10				class_has _api_call => (isa => 'Str', is => 'ro', default => 'DeleteDBInstance');
11				class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::DeleteDBInstanceResult');
12				class_has _result_key => (isa => 'Str', is => 'ro', default => 'DeleteDBInstanceResult');
13				1;
14
15				### main pod documentation begin ###
16
17				=head1 NAME
18
19				Paws::RDS::DeleteDBInstance - Arguments for method DeleteDBInstance on Paws::RDS
20
21				=head1 DESCRIPTION
22
23				This class represents the parameters used for calling the method DeleteDBInstance on the
24				Amazon Relational Database Service service. Use the attributes of this class
25				as arguments to method DeleteDBInstance.
26
27				You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DeleteDBInstance.
28
29				As an example:
30
31				$service_obj->DeleteDBInstance(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> DBInstanceIdentifier => Str
39
40				The DB instance identifier for the DB instance 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 DBSnapshotIdentifier of the new DBSnapshot created when
67				SkipFinalSnapshot is set to C<false>.
68
69				Specifying this parameter and also setting the 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				=item *
89
90				Cannot be specified when deleting a Read Replica.
91
92				=back
93
94
95
96
97				=head2 SkipFinalSnapshot => Bool
98
99				Determines whether a final DB snapshot is created before the DB
100				instance is deleted. If C<true> is specified, no DBSnapshot is created.
101				If C<false> is specified, a DB snapshot is created before the DB
102				instance is deleted.
103
104				Note that when a DB instance is in a failure state and has a status of
105				'failed', 'incompatible-restore', or 'incompatible-network', it can
106				only be deleted when the SkipFinalSnapshot parameter is set to "true".
107
108				Specify C<true> when deleting a Read Replica.
109
110				The FinalDBSnapshotIdentifier parameter must be specified if
111				SkipFinalSnapshot is C<false>.
112
113				Default: C<false>
114
115
116
117
118				=head1 SEE ALSO
119
120				This class forms part of L<Paws>, documenting arguments for method DeleteDBInstance in L<Paws::RDS>
121
122				=head1 BUGS and CONTRIBUTIONS
123
124				The source code is located here: https://github.com/pplu/aws-sdk-perl
125
126				Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
127
128				=cut
129