« blib/lib/Paws/RDS/RestoreDBClusterFromS3Result.pm
↑ Summary
blib/lib/Paws/RDS/RestoreDBClusterFromSnapshotResult.pm »
| 1 | |||
| 2 | package Paws::RDS::RestoreDBClusterFromSnapshot; | ||
| 3 | use Moose; | ||
| 4 | has AvailabilityZones => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 5 | has BacktrackWindow => (is => 'ro', isa => 'Int'); | ||
| 6 | has CopyTagsToSnapshot => (is => 'ro', isa => 'Bool'); | ||
| 7 | has DatabaseName => (is => 'ro', isa => 'Str'); | ||
| 8 | has DBClusterIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has DBClusterParameterGroupName => (is => 'ro', isa => 'Str'); | ||
| 10 | has DBSubnetGroupName => (is => 'ro', isa => 'Str'); | ||
| 11 | has DeletionProtection => (is => 'ro', isa => 'Bool'); | ||
| 12 | has Domain => (is => 'ro', isa => 'Str'); | ||
| 13 | has DomainIAMRoleName => (is => 'ro', isa => 'Str'); | ||
| 14 | has EnableCloudwatchLogsExports => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 15 | has EnableIAMDatabaseAuthentication => (is => 'ro', isa => 'Bool'); | ||
| 16 | has Engine => (is => 'ro', isa => 'Str', required => 1); | ||
| 17 | has EngineMode => (is => 'ro', isa => 'Str'); | ||
| 18 | has EngineVersion => (is => 'ro', isa => 'Str'); | ||
| 19 | has KmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 20 | has OptionGroupName => (is => 'ro', isa => 'Str'); | ||
| 21 | has Port => (is => 'ro', isa => 'Int'); | ||
| 22 | has ScalingConfiguration => (is => 'ro', isa => 'Paws::RDS::ScalingConfiguration'); | ||
| 23 | has SnapshotIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 24 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::RDS::Tag]'); | ||
| 25 | has VpcSecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 26 | |||
| 27 | use MooseX::ClassAttribute; | ||
| 28 | |||
| 29 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'RestoreDBClusterFromSnapshot'); | ||
| 30 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::RestoreDBClusterFromSnapshotResult'); | ||
| 31 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'RestoreDBClusterFromSnapshotResult'); | ||
| 32 | 1; | ||
| 33 | |||
| 34 | ### main pod documentation begin ### | ||
| 35 | |||
| 36 | =head1 NAME | ||
| 37 | |||
| 38 | Paws::RDS::RestoreDBClusterFromSnapshot - Arguments for method RestoreDBClusterFromSnapshot on L<Paws::RDS> | ||
| 39 | |||
| 40 | =head1 DESCRIPTION | ||
| 41 | |||
| 42 | This class represents the parameters used for calling the method RestoreDBClusterFromSnapshot on the | ||
| 43 | L<Amazon Relational Database Service|Paws::RDS> service. Use the attributes of this class | ||
| 44 | as arguments to method RestoreDBClusterFromSnapshot. | ||
| 45 | |||
| 46 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RestoreDBClusterFromSnapshot. | ||
| 47 | |||
| 48 | =head1 SYNOPSIS | ||
| 49 | |||
| 50 | my $rds = Paws->service('RDS'); | ||
| 51 | # To restore an Amazon Aurora DB cluster from a DB cluster snapshot | ||
| 52 | # The following example restores an Amazon Aurora DB cluster from a DB cluster | ||
| 53 | # snapshot. | ||
| 54 | my $RestoreDBClusterFromSnapshotResult = $rds->RestoreDBClusterFromSnapshot( | ||
| 55 | 'DBClusterIdentifier' => 'restored-cluster1', | ||
| 56 | 'Engine' => 'aurora', | ||
| 57 | 'SnapshotIdentifier' => 'sample-cluster-snapshot1' | ||
| 58 | ); | ||
| 59 | |||
| 60 | # Results: | ||
| 61 | my $DBCluster = $RestoreDBClusterFromSnapshotResult->DBCluster; | ||
| 62 | |||
| 63 | # Returns a L<Paws::RDS::RestoreDBClusterFromSnapshotResult> object. | ||
| 64 | |||
| 65 | 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. | ||
| 66 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/RestoreDBClusterFromSnapshot> | ||
| 67 | |||
| 68 | =head1 ATTRIBUTES | ||
| 69 | |||
| 70 | |||
| 71 | =head2 AvailabilityZones => ArrayRef[Str|Undef] | ||
| 72 | |||
| 73 | Provides the list of Availability Zones (AZs) where instances in the | ||
| 74 | restored DB cluster can be created. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 BacktrackWindow => Int | ||
| 79 | |||
| 80 | The target backtrack window, in seconds. To disable backtracking, set | ||
| 81 | this value to 0. | ||
| 82 | |||
| 83 | Currently, Backtrack is only supported for Aurora MySQL DB clusters. | ||
| 84 | |||
| 85 | Default: 0 | ||
| 86 | |||
| 87 | Constraints: | ||
| 88 | |||
| 89 | =over | ||
| 90 | |||
| 91 | =item * | ||
| 92 | |||
| 93 | If specified, this value must be set to a number from 0 to 259,200 (72 | ||
| 94 | hours). | ||
| 95 | |||
| 96 | =back | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head2 CopyTagsToSnapshot => Bool | ||
| 102 | |||
| 103 | A value that indicates whether to copy all tags from the restored DB | ||
| 104 | cluster to snapshots of the restored DB cluster. The default is not to | ||
| 105 | copy them. | ||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | =head2 DatabaseName => Str | ||
| 110 | |||
| 111 | The database name for the restored DB cluster. | ||
| 112 | |||
| 113 | |||
| 114 | |||
| 115 | =head2 B<REQUIRED> DBClusterIdentifier => Str | ||
| 116 | |||
| 117 | The name of the DB cluster to create from the DB snapshot or DB cluster | ||
| 118 | snapshot. This parameter isn't case-sensitive. | ||
| 119 | |||
| 120 | Constraints: | ||
| 121 | |||
| 122 | =over | ||
| 123 | |||
| 124 | =item * | ||
| 125 | |||
| 126 | Must contain from 1 to 63 letters, numbers, or hyphens | ||
| 127 | |||
| 128 | =item * | ||
| 129 | |||
| 130 | First character must be a letter | ||
| 131 | |||
| 132 | =item * | ||
| 133 | |||
| 134 | Can't end with a hyphen or contain two consecutive hyphens | ||
| 135 | |||
| 136 | =back | ||
| 137 | |||
| 138 | Example: C<my-snapshot-id> | ||
| 139 | |||
| 140 | |||
| 141 | |||
| 142 | =head2 DBClusterParameterGroupName => Str | ||
| 143 | |||
| 144 | The name of the DB cluster parameter group to associate with this DB | ||
| 145 | cluster. If this argument is omitted, the default DB cluster parameter | ||
| 146 | group for the specified engine is used. | ||
| 147 | |||
| 148 | Constraints: | ||
| 149 | |||
| 150 | =over | ||
| 151 | |||
| 152 | =item * | ||
| 153 | |||
| 154 | If supplied, must match the name of an existing default DB cluster | ||
| 155 | parameter group. | ||
| 156 | |||
| 157 | =item * | ||
| 158 | |||
| 159 | Must be 1 to 255 letters, numbers, or hyphens. | ||
| 160 | |||
| 161 | =item * | ||
| 162 | |||
| 163 | First character must be a letter. | ||
| 164 | |||
| 165 | =item * | ||
| 166 | |||
| 167 | Can't end with a hyphen or contain two consecutive hyphens. | ||
| 168 | |||
| 169 | =back | ||
| 170 | |||
| 171 | |||
| 172 | |||
| 173 | |||
| 174 | =head2 DBSubnetGroupName => Str | ||
| 175 | |||
| 176 | The name of the DB subnet group to use for the new DB cluster. | ||
| 177 | |||
| 178 | Constraints: If supplied, must match the name of an existing DB subnet | ||
| 179 | group. | ||
| 180 | |||
| 181 | Example: C<mySubnetgroup> | ||
| 182 | |||
| 183 | |||
| 184 | |||
| 185 | =head2 DeletionProtection => Bool | ||
| 186 | |||
| 187 | A value that indicates whether the DB cluster has deletion protection | ||
| 188 | enabled. The database can't be deleted when deletion protection is | ||
| 189 | enabled. By default, deletion protection is disabled. | ||
| 190 | |||
| 191 | |||
| 192 | |||
| 193 | =head2 Domain => Str | ||
| 194 | |||
| 195 | Specify the Active Directory directory ID to restore the DB cluster in. | ||
| 196 | The domain must be created prior to this operation. Currently, only | ||
| 197 | MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be | ||
| 198 | created in an Active Directory Domain. | ||
| 199 | |||
| 200 | For more information, see Kerberos Authentication | ||
| 201 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) | ||
| 202 | in the I<Amazon RDS User Guide>. | ||
| 203 | |||
| 204 | |||
| 205 | |||
| 206 | =head2 DomainIAMRoleName => Str | ||
| 207 | |||
| 208 | Specify the name of the IAM role to be used when making API calls to | ||
| 209 | the Directory Service. | ||
| 210 | |||
| 211 | |||
| 212 | |||
| 213 | =head2 EnableCloudwatchLogsExports => ArrayRef[Str|Undef] | ||
| 214 | |||
| 215 | The list of logs that the restored DB cluster is to export to Amazon | ||
| 216 | CloudWatch Logs. The values in the list depend on the DB engine being | ||
| 217 | used. For more information, see Publishing Database Logs to Amazon | ||
| 218 | CloudWatch Logs | ||
| 219 | (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) | ||
| 220 | in the I<Amazon Aurora User Guide>. | ||
| 221 | |||
| 222 | |||
| 223 | |||
| 224 | =head2 EnableIAMDatabaseAuthentication => Bool | ||
| 225 | |||
| 226 | A value that indicates whether to enable mapping of Amazon Web Services | ||
| 227 | Identity and Access Management (IAM) accounts to database accounts. By | ||
| 228 | default, mapping is disabled. | ||
| 229 | |||
| 230 | For more information, see IAM Database Authentication | ||
| 231 | (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) | ||
| 232 | in the I<Amazon Aurora User Guide.> | ||
| 233 | |||
| 234 | |||
| 235 | |||
| 236 | =head2 B<REQUIRED> Engine => Str | ||
| 237 | |||
| 238 | The database engine to use for the new DB cluster. | ||
| 239 | |||
| 240 | Default: The same as source | ||
| 241 | |||
| 242 | Constraint: Must be compatible with the engine of the source | ||
| 243 | |||
| 244 | |||
| 245 | |||
| 246 | =head2 EngineMode => Str | ||
| 247 | |||
| 248 | The DB engine mode of the DB cluster, either C<provisioned>, | ||
| 249 | C<serverless>, C<parallelquery>, C<global>, or C<multimaster>. | ||
| 250 | |||
| 251 | For more information, see CreateDBCluster | ||
| 252 | (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html). | ||
| 253 | |||
| 254 | |||
| 255 | |||
| 256 | =head2 EngineVersion => Str | ||
| 257 | |||
| 258 | The version of the database engine to use for the new DB cluster. | ||
| 259 | |||
| 260 | To list all of the available engine versions for C<aurora> (for MySQL | ||
| 261 | 5.6-compatible Aurora), use the following command: | ||
| 262 | |||
| 263 | C<aws rds describe-db-engine-versions --engine aurora --query | ||
| 264 | "DBEngineVersions[].EngineVersion"> | ||
| 265 | |||
| 266 | To list all of the available engine versions for C<aurora-mysql> (for | ||
| 267 | MySQL 5.7-compatible Aurora), use the following command: | ||
| 268 | |||
| 269 | C<aws rds describe-db-engine-versions --engine aurora-mysql --query | ||
| 270 | "DBEngineVersions[].EngineVersion"> | ||
| 271 | |||
| 272 | To list all of the available engine versions for C<aurora-postgresql>, | ||
| 273 | use the following command: | ||
| 274 | |||
| 275 | C<aws rds describe-db-engine-versions --engine aurora-postgresql | ||
| 276 | --query "DBEngineVersions[].EngineVersion"> | ||
| 277 | |||
| 278 | If you aren't using the default engine version, then you must specify | ||
| 279 | the engine version. | ||
| 280 | |||
| 281 | B<Aurora MySQL> | ||
| 282 | |||
| 283 | Example: C<5.6.10a>, C<5.6.mysql_aurora.1.19.2>, C<5.7.12>, | ||
| 284 | C<5.7.mysql_aurora.2.04.5> | ||
| 285 | |||
| 286 | B<Aurora PostgreSQL> | ||
| 287 | |||
| 288 | Example: C<9.6.3>, C<10.7> | ||
| 289 | |||
| 290 | |||
| 291 | |||
| 292 | =head2 KmsKeyId => Str | ||
| 293 | |||
| 294 | The Amazon Web Services KMS key identifier to use when restoring an | ||
| 295 | encrypted DB cluster from a DB snapshot or DB cluster snapshot. | ||
| 296 | |||
| 297 | The Amazon Web Services KMS key identifier is the key ARN, key ID, | ||
| 298 | alias ARN, or alias name for the Amazon Web Services KMS customer | ||
| 299 | master key (CMK). To use a CMK in a different Amazon Web Services | ||
| 300 | account, specify the key ARN or alias ARN. | ||
| 301 | |||
| 302 | When you don't specify a value for the C<KmsKeyId> parameter, then the | ||
| 303 | following occurs: | ||
| 304 | |||
| 305 | =over | ||
| 306 | |||
| 307 | =item * | ||
| 308 | |||
| 309 | If the DB snapshot or DB cluster snapshot in C<SnapshotIdentifier> is | ||
| 310 | encrypted, then the restored DB cluster is encrypted using the Amazon | ||
| 311 | Web Services KMS CMK that was used to encrypt the DB snapshot or DB | ||
| 312 | cluster snapshot. | ||
| 313 | |||
| 314 | =item * | ||
| 315 | |||
| 316 | If the DB snapshot or DB cluster snapshot in C<SnapshotIdentifier> | ||
| 317 | isn't encrypted, then the restored DB cluster isn't encrypted. | ||
| 318 | |||
| 319 | =back | ||
| 320 | |||
| 321 | |||
| 322 | |||
| 323 | |||
| 324 | =head2 OptionGroupName => Str | ||
| 325 | |||
| 326 | The name of the option group to use for the restored DB cluster. | ||
| 327 | |||
| 328 | |||
| 329 | |||
| 330 | =head2 Port => Int | ||
| 331 | |||
| 332 | The port number on which the new DB cluster accepts connections. | ||
| 333 | |||
| 334 | Constraints: This value must be C<1150-65535> | ||
| 335 | |||
| 336 | Default: The same port as the original DB cluster. | ||
| 337 | |||
| 338 | |||
| 339 | |||
| 340 | =head2 ScalingConfiguration => L<Paws::RDS::ScalingConfiguration> | ||
| 341 | |||
| 342 | For DB clusters in C<serverless> DB engine mode, the scaling properties | ||
| 343 | of the DB cluster. | ||
| 344 | |||
| 345 | |||
| 346 | |||
| 347 | =head2 B<REQUIRED> SnapshotIdentifier => Str | ||
| 348 | |||
| 349 | The identifier for the DB snapshot or DB cluster snapshot to restore | ||
| 350 | from. | ||
| 351 | |||
| 352 | You can use either the name or the Amazon Resource Name (ARN) to | ||
| 353 | specify a DB cluster snapshot. However, you can use only the ARN to | ||
| 354 | specify a DB snapshot. | ||
| 355 | |||
| 356 | Constraints: | ||
| 357 | |||
| 358 | =over | ||
| 359 | |||
| 360 | =item * | ||
| 361 | |||
| 362 | Must match the identifier of an existing Snapshot. | ||
| 363 | |||
| 364 | =back | ||
| 365 | |||
| 366 | |||
| 367 | |||
| 368 | |||
| 369 | =head2 Tags => ArrayRef[L<Paws::RDS::Tag>] | ||
| 370 | |||
| 371 | The tags to be assigned to the restored DB cluster. | ||
| 372 | |||
| 373 | |||
| 374 | |||
| 375 | =head2 VpcSecurityGroupIds => ArrayRef[Str|Undef] | ||
| 376 | |||
| 377 | A list of VPC security groups that the new DB cluster will belong to. | ||
| 378 | |||
| 379 | |||
| 380 | |||
| 381 | |||
| 382 | =head1 SEE ALSO | ||
| 383 | |||
| 384 | This class forms part of L<Paws>, documenting arguments for method RestoreDBClusterFromSnapshot in L<Paws::RDS> | ||
| 385 | |||
| 386 | =head1 BUGS and CONTRIBUTIONS | ||
| 387 | |||
| 388 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 389 | |||
| 390 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 391 | |||
| 392 | =cut | ||
| 393 |