File Coverage

blib/lib/Paws/RDS/RestoreDBClusterFromSnapshot.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::RestoreDBClusterFromSnapshot;
3 1     1   424 use Moose;
  1         2  
  1         6  
4             has AvailabilityZones => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
5             has DatabaseName => (is => 'ro', isa => 'Str');
6             has DBClusterIdentifier => (is => 'ro', isa => 'Str', required => 1);
7             has DBSubnetGroupName => (is => 'ro', isa => 'Str');
8             has EnableIAMDatabaseAuthentication => (is => 'ro', isa => 'Bool');
9             has Engine => (is => 'ro', isa => 'Str', required => 1);
10             has EngineVersion => (is => 'ro', isa => 'Str');
11             has KmsKeyId => (is => 'ro', isa => 'Str');
12             has OptionGroupName => (is => 'ro', isa => 'Str');
13             has Port => (is => 'ro', isa => 'Int');
14             has SnapshotIdentifier => (is => 'ro', isa => 'Str', required => 1);
15             has Tags => (is => 'ro', isa => 'ArrayRef[Paws::RDS::Tag]');
16             has VpcSecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
17              
18 1     1   5772 use MooseX::ClassAttribute;
  1         2  
  1         10  
19              
20             class_has _api_call => (isa => 'Str', is => 'ro', default => 'RestoreDBClusterFromSnapshot');
21             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::RestoreDBClusterFromSnapshotResult');
22             class_has _result_key => (isa => 'Str', is => 'ro', default => 'RestoreDBClusterFromSnapshotResult');
23             1;
24              
25             ### main pod documentation begin ###
26              
27             =head1 NAME
28              
29             Paws::RDS::RestoreDBClusterFromSnapshot - Arguments for method RestoreDBClusterFromSnapshot on Paws::RDS
30              
31             =head1 DESCRIPTION
32              
33             This class represents the parameters used for calling the method RestoreDBClusterFromSnapshot on the
34             Amazon Relational Database Service service. Use the attributes of this class
35             as arguments to method RestoreDBClusterFromSnapshot.
36              
37             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RestoreDBClusterFromSnapshot.
38              
39             As an example:
40              
41             $service_obj->RestoreDBClusterFromSnapshot(Att1 => $value1, Att2 => $value2, ...);
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              
45             =head1 ATTRIBUTES
46              
47              
48             =head2 AvailabilityZones => ArrayRef[Str|Undef]
49              
50             Provides the list of EC2 Availability Zones that instances in the
51             restored DB cluster can be created in.
52              
53              
54              
55             =head2 DatabaseName => Str
56              
57             The database name for the restored DB cluster.
58              
59              
60              
61             =head2 B<REQUIRED> DBClusterIdentifier => Str
62              
63             The name of the DB cluster to create from the DB snapshot or DB cluster
64             snapshot. This parameter isn't case-sensitive.
65              
66             Constraints:
67              
68             =over
69              
70             =item *
71              
72             Must contain from 1 to 255 alphanumeric characters or hyphens
73              
74             =item *
75              
76             First character must be a letter
77              
78             =item *
79              
80             Cannot end with a hyphen or contain two consecutive hyphens
81              
82             =back
83              
84             Example: C<my-snapshot-id>
85              
86              
87              
88             =head2 DBSubnetGroupName => Str
89              
90             The name of the DB subnet group to use for the new DB cluster.
91              
92             Constraints: Must contain no more than 255 alphanumeric characters,
93             periods, underscores, spaces, or hyphens. Must not be default.
94              
95             Example: C<mySubnetgroup>
96              
97              
98              
99             =head2 EnableIAMDatabaseAuthentication => Bool
100              
101             A Boolean value that is true to enable mapping of AWS Identity and
102             Access Management (IAM) accounts to database accounts, and otherwise
103             false.
104              
105             Default: C<false>
106              
107              
108              
109             =head2 B<REQUIRED> Engine => Str
110              
111             The database engine to use for the new DB cluster.
112              
113             Default: The same as source
114              
115             Constraint: Must be compatible with the engine of the source
116              
117              
118              
119             =head2 EngineVersion => Str
120              
121             The version of the database engine to use for the new DB cluster.
122              
123              
124              
125             =head2 KmsKeyId => Str
126              
127             The KMS key identifier to use when restoring an encrypted DB cluster
128             from a DB snapshot or DB cluster snapshot.
129              
130             The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
131             encryption key. If you are restoring a DB cluster with the same AWS
132             account that owns the KMS encryption key used to encrypt the new DB
133             cluster, then you can use the KMS key alias instead of the ARN for the
134             KMS encryption key.
135              
136             If you do not specify a value for the C<KmsKeyId> parameter, then the
137             following will occur:
138              
139             =over
140              
141             =item *
142              
143             If the DB snapshot or DB cluster snapshot in C<SnapshotIdentifier> is
144             encrypted, then the restored DB cluster is encrypted using the KMS key
145             that was used to encrypt the DB snapshot or DB cluster snapshot.
146              
147             =item *
148              
149             If the DB snapshot or DB cluster snapshot in C<SnapshotIdentifier> is
150             not encrypted, then the restored DB cluster is not encrypted.
151              
152             =back
153              
154              
155              
156              
157             =head2 OptionGroupName => Str
158              
159             The name of the option group to use for the restored DB cluster.
160              
161              
162              
163             =head2 Port => Int
164              
165             The port number on which the new DB cluster accepts connections.
166              
167             Constraints: Value must be C<1150-65535>
168              
169             Default: The same port as the original DB cluster.
170              
171              
172              
173             =head2 B<REQUIRED> SnapshotIdentifier => Str
174              
175             The identifier for the DB snapshot or DB cluster snapshot to restore
176             from.
177              
178             You can use either the name or the Amazon Resource Name (ARN) to
179             specify a DB cluster snapshot. However, you can use only the ARN to
180             specify a DB snapshot.
181              
182             Constraints:
183              
184             =over
185              
186             =item *
187              
188             Must contain from 1 to 63 alphanumeric characters or hyphens
189              
190             =item *
191              
192             First character must be a letter
193              
194             =item *
195              
196             Cannot end with a hyphen or contain two consecutive hyphens
197              
198             =back
199              
200              
201              
202              
203             =head2 Tags => ArrayRef[L<Paws::RDS::Tag>]
204              
205             The tags to be assigned to the restored DB cluster.
206              
207              
208              
209             =head2 VpcSecurityGroupIds => ArrayRef[Str|Undef]
210              
211             A list of VPC security groups that the new DB cluster will belong to.
212              
213              
214              
215              
216             =head1 SEE ALSO
217              
218             This class forms part of L<Paws>, documenting arguments for method RestoreDBClusterFromSnapshot in L<Paws::RDS>
219              
220             =head1 BUGS and CONTRIBUTIONS
221              
222             The source code is located here: https://github.com/pplu/aws-sdk-perl
223              
224             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
225              
226             =cut
227