« blib/lib/Paws/RDS/RestoreDBInstanceFromDBSnapshotResult.pm
↑ Summary
blib/lib/Paws/RDS/RestoreDBInstanceFromS3Result.pm »
| 1 | |||
| 2 | package Paws::RDS::RestoreDBInstanceFromS3; | ||
| 3 | use Moose; | ||
| 4 | has AllocatedStorage => (is => 'ro', isa => 'Int'); | ||
| 5 | has AutoMinorVersionUpgrade => (is => 'ro', isa => 'Bool'); | ||
| 6 | has AvailabilityZone => (is => 'ro', isa => 'Str'); | ||
| 7 | has BackupRetentionPeriod => (is => 'ro', isa => 'Int'); | ||
| 8 | has CopyTagsToSnapshot => (is => 'ro', isa => 'Bool'); | ||
| 9 | has DBInstanceClass => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | has DBInstanceIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | has DBName => (is => 'ro', isa => 'Str'); | ||
| 12 | has DBParameterGroupName => (is => 'ro', isa => 'Str'); | ||
| 13 | has DBSecurityGroups => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 14 | has DBSubnetGroupName => (is => 'ro', isa => 'Str'); | ||
| 15 | has DeletionProtection => (is => 'ro', isa => 'Bool'); | ||
| 16 | has EnableCloudwatchLogsExports => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 17 | has EnableIAMDatabaseAuthentication => (is => 'ro', isa => 'Bool'); | ||
| 18 | has EnablePerformanceInsights => (is => 'ro', isa => 'Bool'); | ||
| 19 | has Engine => (is => 'ro', isa => 'Str', required => 1); | ||
| 20 | has EngineVersion => (is => 'ro', isa => 'Str'); | ||
| 21 | has Iops => (is => 'ro', isa => 'Int'); | ||
| 22 | has KmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 23 | has LicenseModel => (is => 'ro', isa => 'Str'); | ||
| 24 | has MasterUsername => (is => 'ro', isa => 'Str'); | ||
| 25 | has MasterUserPassword => (is => 'ro', isa => 'Str'); | ||
| 26 | has MaxAllocatedStorage => (is => 'ro', isa => 'Int'); | ||
| 27 | has MonitoringInterval => (is => 'ro', isa => 'Int'); | ||
| 28 | has MonitoringRoleArn => (is => 'ro', isa => 'Str'); | ||
| 29 | has MultiAZ => (is => 'ro', isa => 'Bool'); | ||
| 30 | has OptionGroupName => (is => 'ro', isa => 'Str'); | ||
| 31 | has PerformanceInsightsKMSKeyId => (is => 'ro', isa => 'Str'); | ||
| 32 | has PerformanceInsightsRetentionPeriod => (is => 'ro', isa => 'Int'); | ||
| 33 | has Port => (is => 'ro', isa => 'Int'); | ||
| 34 | has PreferredBackupWindow => (is => 'ro', isa => 'Str'); | ||
| 35 | has PreferredMaintenanceWindow => (is => 'ro', isa => 'Str'); | ||
| 36 | has ProcessorFeatures => (is => 'ro', isa => 'ArrayRef[Paws::RDS::ProcessorFeature]'); | ||
| 37 | has PubliclyAccessible => (is => 'ro', isa => 'Bool'); | ||
| 38 | has S3BucketName => (is => 'ro', isa => 'Str', required => 1); | ||
| 39 | has S3IngestionRoleArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 40 | has S3Prefix => (is => 'ro', isa => 'Str'); | ||
| 41 | has SourceEngine => (is => 'ro', isa => 'Str', required => 1); | ||
| 42 | has SourceEngineVersion => (is => 'ro', isa => 'Str', required => 1); | ||
| 43 | has StorageEncrypted => (is => 'ro', isa => 'Bool'); | ||
| 44 | has StorageType => (is => 'ro', isa => 'Str'); | ||
| 45 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::RDS::Tag]'); | ||
| 46 | has UseDefaultProcessorFeatures => (is => 'ro', isa => 'Bool'); | ||
| 47 | has VpcSecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 48 | |||
| 49 | use MooseX::ClassAttribute; | ||
| 50 | |||
| 51 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'RestoreDBInstanceFromS3'); | ||
| 52 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::RestoreDBInstanceFromS3Result'); | ||
| 53 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'RestoreDBInstanceFromS3Result'); | ||
| 54 | 1; | ||
| 55 | |||
| 56 | ### main pod documentation begin ### | ||
| 57 | |||
| 58 | =head1 NAME | ||
| 59 | |||
| 60 | Paws::RDS::RestoreDBInstanceFromS3 - Arguments for method RestoreDBInstanceFromS3 on L<Paws::RDS> | ||
| 61 | |||
| 62 | =head1 DESCRIPTION | ||
| 63 | |||
| 64 | This class represents the parameters used for calling the method RestoreDBInstanceFromS3 on the | ||
| 65 | L<Amazon Relational Database Service|Paws::RDS> service. Use the attributes of this class | ||
| 66 | as arguments to method RestoreDBInstanceFromS3. | ||
| 67 | |||
| 68 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RestoreDBInstanceFromS3. | ||
| 69 | |||
| 70 | =head1 SYNOPSIS | ||
| 71 | |||
| 72 | my $rds = Paws->service('RDS'); | ||
| 73 | my $RestoreDBInstanceFromS3Result = $rds->RestoreDBInstanceFromS3( | ||
| 74 | DBInstanceClass => 'MyString', | ||
| 75 | DBInstanceIdentifier => 'MyString', | ||
| 76 | Engine => 'MyString', | ||
| 77 | S3BucketName => 'MyString', | ||
| 78 | S3IngestionRoleArn => 'MyString', | ||
| 79 | SourceEngine => 'MyString', | ||
| 80 | SourceEngineVersion => 'MyString', | ||
| 81 | AllocatedStorage => 1, # OPTIONAL | ||
| 82 | AutoMinorVersionUpgrade => 1, # OPTIONAL | ||
| 83 | AvailabilityZone => 'MyString', # OPTIONAL | ||
| 84 | BackupRetentionPeriod => 1, # OPTIONAL | ||
| 85 | CopyTagsToSnapshot => 1, # OPTIONAL | ||
| 86 | DBName => 'MyString', # OPTIONAL | ||
| 87 | DBParameterGroupName => 'MyString', # OPTIONAL | ||
| 88 | DBSecurityGroups => [ 'MyString', ... ], # OPTIONAL | ||
| 89 | DBSubnetGroupName => 'MyString', # OPTIONAL | ||
| 90 | DeletionProtection => 1, # OPTIONAL | ||
| 91 | EnableCloudwatchLogsExports => [ 'MyString', ... ], # OPTIONAL | ||
| 92 | EnableIAMDatabaseAuthentication => 1, # OPTIONAL | ||
| 93 | EnablePerformanceInsights => 1, # OPTIONAL | ||
| 94 | EngineVersion => 'MyString', # OPTIONAL | ||
| 95 | Iops => 1, # OPTIONAL | ||
| 96 | KmsKeyId => 'MyString', # OPTIONAL | ||
| 97 | LicenseModel => 'MyString', # OPTIONAL | ||
| 98 | MasterUserPassword => 'MyString', # OPTIONAL | ||
| 99 | MasterUsername => 'MyString', # OPTIONAL | ||
| 100 | MaxAllocatedStorage => 1, # OPTIONAL | ||
| 101 | MonitoringInterval => 1, # OPTIONAL | ||
| 102 | MonitoringRoleArn => 'MyString', # OPTIONAL | ||
| 103 | MultiAZ => 1, # OPTIONAL | ||
| 104 | OptionGroupName => 'MyString', # OPTIONAL | ||
| 105 | PerformanceInsightsKMSKeyId => 'MyString', # OPTIONAL | ||
| 106 | PerformanceInsightsRetentionPeriod => 1, # OPTIONAL | ||
| 107 | Port => 1, # OPTIONAL | ||
| 108 | PreferredBackupWindow => 'MyString', # OPTIONAL | ||
| 109 | PreferredMaintenanceWindow => 'MyString', # OPTIONAL | ||
| 110 | ProcessorFeatures => [ | ||
| 111 | { | ||
| 112 | Name => 'MyString', | ||
| 113 | Value => 'MyString', | ||
| 114 | }, | ||
| 115 | ... | ||
| 116 | ], # OPTIONAL | ||
| 117 | PubliclyAccessible => 1, # OPTIONAL | ||
| 118 | S3Prefix => 'MyString', # OPTIONAL | ||
| 119 | StorageEncrypted => 1, # OPTIONAL | ||
| 120 | StorageType => 'MyString', # OPTIONAL | ||
| 121 | Tags => [ | ||
| 122 | { | ||
| 123 | Key => 'MyString', | ||
| 124 | Value => 'MyString', | ||
| 125 | }, | ||
| 126 | ... | ||
| 127 | ], # OPTIONAL | ||
| 128 | UseDefaultProcessorFeatures => 1, # OPTIONAL | ||
| 129 | VpcSecurityGroupIds => [ 'MyString', ... ], # OPTIONAL | ||
| 130 | ); | ||
| 131 | |||
| 132 | # Results: | ||
| 133 | my $DBInstance = $RestoreDBInstanceFromS3Result->DBInstance; | ||
| 134 | |||
| 135 | # Returns a L<Paws::RDS::RestoreDBInstanceFromS3Result> object. | ||
| 136 | |||
| 137 | 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. | ||
| 138 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/RestoreDBInstanceFromS3> | ||
| 139 | |||
| 140 | =head1 ATTRIBUTES | ||
| 141 | |||
| 142 | |||
| 143 | =head2 AllocatedStorage => Int | ||
| 144 | |||
| 145 | The amount of storage (in gigabytes) to allocate initially for the DB | ||
| 146 | instance. Follow the allocation rules specified in C<CreateDBInstance>. | ||
| 147 | |||
| 148 | Be sure to allocate enough memory for your new DB instance so that the | ||
| 149 | restore operation can succeed. You can also allocate additional memory | ||
| 150 | for future growth. | ||
| 151 | |||
| 152 | |||
| 153 | |||
| 154 | =head2 AutoMinorVersionUpgrade => Bool | ||
| 155 | |||
| 156 | A value that indicates whether minor engine upgrades are applied | ||
| 157 | automatically to the DB instance during the maintenance window. By | ||
| 158 | default, minor engine upgrades are not applied automatically. | ||
| 159 | |||
| 160 | |||
| 161 | |||
| 162 | =head2 AvailabilityZone => Str | ||
| 163 | |||
| 164 | The Availability Zone that the DB instance is created in. For | ||
| 165 | information about Amazon Web Services Regions and Availability Zones, | ||
| 166 | see Regions and Availability Zones | ||
| 167 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html) | ||
| 168 | in the I<Amazon RDS User Guide.> | ||
| 169 | |||
| 170 | Default: A random, system-chosen Availability Zone in the endpoint's | ||
| 171 | Amazon Web Services Region. | ||
| 172 | |||
| 173 | Example: C<us-east-1d> | ||
| 174 | |||
| 175 | Constraint: The C<AvailabilityZone> parameter can't be specified if the | ||
| 176 | DB instance is a Multi-AZ deployment. The specified Availability Zone | ||
| 177 | must be in the same Amazon Web Services Region as the current endpoint. | ||
| 178 | |||
| 179 | |||
| 180 | |||
| 181 | =head2 BackupRetentionPeriod => Int | ||
| 182 | |||
| 183 | The number of days for which automated backups are retained. Setting | ||
| 184 | this parameter to a positive number enables backups. For more | ||
| 185 | information, see C<CreateDBInstance>. | ||
| 186 | |||
| 187 | |||
| 188 | |||
| 189 | =head2 CopyTagsToSnapshot => Bool | ||
| 190 | |||
| 191 | A value that indicates whether to copy all tags from the DB instance to | ||
| 192 | snapshots of the DB instance. By default, tags are not copied. | ||
| 193 | |||
| 194 | |||
| 195 | |||
| 196 | =head2 B<REQUIRED> DBInstanceClass => Str | ||
| 197 | |||
| 198 | The compute and memory capacity of the DB instance, for example, | ||
| 199 | C<db.m4.large>. Not all DB instance classes are available in all Amazon | ||
| 200 | Web Services Regions, or for all database engines. For the full list of | ||
| 201 | DB instance classes, and availability for your engine, see DB Instance | ||
| 202 | Class | ||
| 203 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) | ||
| 204 | in the I<Amazon RDS User Guide.> | ||
| 205 | |||
| 206 | Importing from Amazon S3 isn't supported on the db.t2.micro DB instance | ||
| 207 | class. | ||
| 208 | |||
| 209 | |||
| 210 | |||
| 211 | =head2 B<REQUIRED> DBInstanceIdentifier => Str | ||
| 212 | |||
| 213 | The DB instance identifier. This parameter is stored as a lowercase | ||
| 214 | string. | ||
| 215 | |||
| 216 | Constraints: | ||
| 217 | |||
| 218 | =over | ||
| 219 | |||
| 220 | =item * | ||
| 221 | |||
| 222 | Must contain from 1 to 63 letters, numbers, or hyphens. | ||
| 223 | |||
| 224 | =item * | ||
| 225 | |||
| 226 | First character must be a letter. | ||
| 227 | |||
| 228 | =item * | ||
| 229 | |||
| 230 | Can't end with a hyphen or contain two consecutive hyphens. | ||
| 231 | |||
| 232 | =back | ||
| 233 | |||
| 234 | Example: C<mydbinstance> | ||
| 235 | |||
| 236 | |||
| 237 | |||
| 238 | =head2 DBName => Str | ||
| 239 | |||
| 240 | The name of the database to create when the DB instance is created. | ||
| 241 | Follow the naming rules specified in C<CreateDBInstance>. | ||
| 242 | |||
| 243 | |||
| 244 | |||
| 245 | =head2 DBParameterGroupName => Str | ||
| 246 | |||
| 247 | The name of the DB parameter group to associate with this DB instance. | ||
| 248 | |||
| 249 | If you do not specify a value for C<DBParameterGroupName>, then the | ||
| 250 | default C<DBParameterGroup> for the specified DB engine is used. | ||
| 251 | |||
| 252 | |||
| 253 | |||
| 254 | =head2 DBSecurityGroups => ArrayRef[Str|Undef] | ||
| 255 | |||
| 256 | A list of DB security groups to associate with this DB instance. | ||
| 257 | |||
| 258 | Default: The default DB security group for the database engine. | ||
| 259 | |||
| 260 | |||
| 261 | |||
| 262 | =head2 DBSubnetGroupName => Str | ||
| 263 | |||
| 264 | A DB subnet group to associate with this DB instance. | ||
| 265 | |||
| 266 | |||
| 267 | |||
| 268 | =head2 DeletionProtection => Bool | ||
| 269 | |||
| 270 | A value that indicates whether the DB instance has deletion protection | ||
| 271 | enabled. The database can't be deleted when deletion protection is | ||
| 272 | enabled. By default, deletion protection is disabled. For more | ||
| 273 | information, see Deleting a DB Instance | ||
| 274 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). | ||
| 275 | |||
| 276 | |||
| 277 | |||
| 278 | =head2 EnableCloudwatchLogsExports => ArrayRef[Str|Undef] | ||
| 279 | |||
| 280 | The list of logs that the restored DB instance is to export to | ||
| 281 | CloudWatch Logs. The values in the list depend on the DB engine being | ||
| 282 | used. For more information, see Publishing Database Logs to Amazon | ||
| 283 | CloudWatch Logs | ||
| 284 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) | ||
| 285 | in the I<Amazon RDS User Guide>. | ||
| 286 | |||
| 287 | |||
| 288 | |||
| 289 | =head2 EnableIAMDatabaseAuthentication => Bool | ||
| 290 | |||
| 291 | A value that indicates whether to enable mapping of Amazon Web Services | ||
| 292 | Identity and Access Management (IAM) accounts to database accounts. By | ||
| 293 | default, mapping is disabled. | ||
| 294 | |||
| 295 | For more information about IAM database authentication, see IAM | ||
| 296 | Database Authentication for MySQL and PostgreSQL | ||
| 297 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) | ||
| 298 | in the I<Amazon RDS User Guide.> | ||
| 299 | |||
| 300 | |||
| 301 | |||
| 302 | =head2 EnablePerformanceInsights => Bool | ||
| 303 | |||
| 304 | A value that indicates whether to enable Performance Insights for the | ||
| 305 | DB instance. | ||
| 306 | |||
| 307 | For more information, see Using Amazon Performance Insights | ||
| 308 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) | ||
| 309 | in the I<Amazon Relational Database Service User Guide>. | ||
| 310 | |||
| 311 | |||
| 312 | |||
| 313 | =head2 B<REQUIRED> Engine => Str | ||
| 314 | |||
| 315 | The name of the database engine to be used for this instance. | ||
| 316 | |||
| 317 | Valid Values: C<mysql> | ||
| 318 | |||
| 319 | |||
| 320 | |||
| 321 | =head2 EngineVersion => Str | ||
| 322 | |||
| 323 | The version number of the database engine to use. Choose the latest | ||
| 324 | minor version of your database engine. For information about engine | ||
| 325 | versions, see C<CreateDBInstance>, or call C<DescribeDBEngineVersions>. | ||
| 326 | |||
| 327 | |||
| 328 | |||
| 329 | =head2 Iops => Int | ||
| 330 | |||
| 331 | The amount of Provisioned IOPS (input/output operations per second) to | ||
| 332 | allocate initially for the DB instance. For information about valid | ||
| 333 | Iops values, see Amazon RDS Provisioned IOPS Storage to Improve | ||
| 334 | Performance | ||
| 335 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) | ||
| 336 | in the I<Amazon RDS User Guide.> | ||
| 337 | |||
| 338 | |||
| 339 | |||
| 340 | =head2 KmsKeyId => Str | ||
| 341 | |||
| 342 | The Amazon Web Services KMS key identifier for an encrypted DB | ||
| 343 | instance. | ||
| 344 | |||
| 345 | The Amazon Web Services KMS key identifier is the key ARN, key ID, | ||
| 346 | alias ARN, or alias name for the Amazon Web Services KMS customer | ||
| 347 | master key (CMK). To use a CMK in a different Amazon Web Services | ||
| 348 | account, specify the key ARN or alias ARN. | ||
| 349 | |||
| 350 | If the C<StorageEncrypted> parameter is enabled, and you do not specify | ||
| 351 | a value for the C<KmsKeyId> parameter, then Amazon RDS will use your | ||
| 352 | default CMK. There is a default CMK for your Amazon Web Services | ||
| 353 | account. Your Amazon Web Services account has a different default CMK | ||
| 354 | for each Amazon Web Services Region. | ||
| 355 | |||
| 356 | |||
| 357 | |||
| 358 | =head2 LicenseModel => Str | ||
| 359 | |||
| 360 | The license model for this DB instance. Use C<general-public-license>. | ||
| 361 | |||
| 362 | |||
| 363 | |||
| 364 | =head2 MasterUsername => Str | ||
| 365 | |||
| 366 | The name for the master user. | ||
| 367 | |||
| 368 | Constraints: | ||
| 369 | |||
| 370 | =over | ||
| 371 | |||
| 372 | =item * | ||
| 373 | |||
| 374 | Must be 1 to 16 letters or numbers. | ||
| 375 | |||
| 376 | =item * | ||
| 377 | |||
| 378 | First character must be a letter. | ||
| 379 | |||
| 380 | =item * | ||
| 381 | |||
| 382 | Can't be a reserved word for the chosen database engine. | ||
| 383 | |||
| 384 | =back | ||
| 385 | |||
| 386 | |||
| 387 | |||
| 388 | |||
| 389 | =head2 MasterUserPassword => Str | ||
| 390 | |||
| 391 | The password for the master user. The password can include any | ||
| 392 | printable ASCII character except "/", """, or "@". | ||
| 393 | |||
| 394 | Constraints: Must contain from 8 to 41 characters. | ||
| 395 | |||
| 396 | |||
| 397 | |||
| 398 | =head2 MaxAllocatedStorage => Int | ||
| 399 | |||
| 400 | The upper limit to which Amazon RDS can automatically scale the storage | ||
| 401 | of the DB instance. | ||
| 402 | |||
| 403 | For more information about this setting, including limitations that | ||
| 404 | apply to it, see Managing capacity automatically with Amazon RDS | ||
| 405 | storage autoscaling | ||
| 406 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) | ||
| 407 | in the I<Amazon RDS User Guide>. | ||
| 408 | |||
| 409 | |||
| 410 | |||
| 411 | =head2 MonitoringInterval => Int | ||
| 412 | |||
| 413 | The interval, in seconds, between points when Enhanced Monitoring | ||
| 414 | metrics are collected for the DB instance. To disable collecting | ||
| 415 | Enhanced Monitoring metrics, specify 0. | ||
| 416 | |||
| 417 | If C<MonitoringRoleArn> is specified, then you must also set | ||
| 418 | C<MonitoringInterval> to a value other than 0. | ||
| 419 | |||
| 420 | Valid Values: 0, 1, 5, 10, 15, 30, 60 | ||
| 421 | |||
| 422 | Default: C<0> | ||
| 423 | |||
| 424 | |||
| 425 | |||
| 426 | =head2 MonitoringRoleArn => Str | ||
| 427 | |||
| 428 | The ARN for the IAM role that permits RDS to send enhanced monitoring | ||
| 429 | metrics to Amazon CloudWatch Logs. For example, | ||
| 430 | C<arn:aws:iam:123456789012:role/emaccess>. For information on creating | ||
| 431 | a monitoring role, see Setting Up and Enabling Enhanced Monitoring | ||
| 432 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) | ||
| 433 | in the I<Amazon RDS User Guide.> | ||
| 434 | |||
| 435 | If C<MonitoringInterval> is set to a value other than 0, then you must | ||
| 436 | supply a C<MonitoringRoleArn> value. | ||
| 437 | |||
| 438 | |||
| 439 | |||
| 440 | =head2 MultiAZ => Bool | ||
| 441 | |||
| 442 | A value that indicates whether the DB instance is a Multi-AZ | ||
| 443 | deployment. If the DB instance is a Multi-AZ deployment, you can't set | ||
| 444 | the C<AvailabilityZone> parameter. | ||
| 445 | |||
| 446 | |||
| 447 | |||
| 448 | =head2 OptionGroupName => Str | ||
| 449 | |||
| 450 | The name of the option group to associate with this DB instance. If | ||
| 451 | this argument is omitted, the default option group for the specified | ||
| 452 | engine is used. | ||
| 453 | |||
| 454 | |||
| 455 | |||
| 456 | =head2 PerformanceInsightsKMSKeyId => Str | ||
| 457 | |||
| 458 | The Amazon Web Services KMS key identifier for encryption of | ||
| 459 | Performance Insights data. | ||
| 460 | |||
| 461 | The Amazon Web Services KMS key identifier is the key ARN, key ID, | ||
| 462 | alias ARN, or alias name for the Amazon Web Services KMS customer | ||
| 463 | master key (CMK). | ||
| 464 | |||
| 465 | If you do not specify a value for C<PerformanceInsightsKMSKeyId>, then | ||
| 466 | Amazon RDS uses your default CMK. There is a default CMK for your | ||
| 467 | Amazon Web Services account. Your Amazon Web Services account has a | ||
| 468 | different default CMK for each Amazon Web Services Region. | ||
| 469 | |||
| 470 | |||
| 471 | |||
| 472 | =head2 PerformanceInsightsRetentionPeriod => Int | ||
| 473 | |||
| 474 | The amount of time, in days, to retain Performance Insights data. Valid | ||
| 475 | values are 7 or 731 (2 years). | ||
| 476 | |||
| 477 | |||
| 478 | |||
| 479 | =head2 Port => Int | ||
| 480 | |||
| 481 | The port number on which the database accepts connections. | ||
| 482 | |||
| 483 | Type: Integer | ||
| 484 | |||
| 485 | Valid Values: C<1150>-C<65535> | ||
| 486 | |||
| 487 | Default: C<3306> | ||
| 488 | |||
| 489 | |||
| 490 | |||
| 491 | =head2 PreferredBackupWindow => Str | ||
| 492 | |||
| 493 | The time range each day during which automated backups are created if | ||
| 494 | automated backups are enabled. For more information, see Backup window | ||
| 495 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) | ||
| 496 | in the I<Amazon RDS User Guide.> | ||
| 497 | |||
| 498 | Constraints: | ||
| 499 | |||
| 500 | =over | ||
| 501 | |||
| 502 | =item * | ||
| 503 | |||
| 504 | Must be in the format C<hh24:mi-hh24:mi>. | ||
| 505 | |||
| 506 | =item * | ||
| 507 | |||
| 508 | Must be in Universal Coordinated Time (UTC). | ||
| 509 | |||
| 510 | =item * | ||
| 511 | |||
| 512 | Must not conflict with the preferred maintenance window. | ||
| 513 | |||
| 514 | =item * | ||
| 515 | |||
| 516 | Must be at least 30 minutes. | ||
| 517 | |||
| 518 | =back | ||
| 519 | |||
| 520 | |||
| 521 | |||
| 522 | |||
| 523 | =head2 PreferredMaintenanceWindow => Str | ||
| 524 | |||
| 525 | The time range each week during which system maintenance can occur, in | ||
| 526 | Universal Coordinated Time (UTC). For more information, see Amazon RDS | ||
| 527 | Maintenance Window | ||
| 528 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance) | ||
| 529 | in the I<Amazon RDS User Guide.> | ||
| 530 | |||
| 531 | Constraints: | ||
| 532 | |||
| 533 | =over | ||
| 534 | |||
| 535 | =item * | ||
| 536 | |||
| 537 | Must be in the format C<ddd:hh24:mi-ddd:hh24:mi>. | ||
| 538 | |||
| 539 | =item * | ||
| 540 | |||
| 541 | Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. | ||
| 542 | |||
| 543 | =item * | ||
| 544 | |||
| 545 | Must be in Universal Coordinated Time (UTC). | ||
| 546 | |||
| 547 | =item * | ||
| 548 | |||
| 549 | Must not conflict with the preferred backup window. | ||
| 550 | |||
| 551 | =item * | ||
| 552 | |||
| 553 | Must be at least 30 minutes. | ||
| 554 | |||
| 555 | =back | ||
| 556 | |||
| 557 | |||
| 558 | |||
| 559 | |||
| 560 | =head2 ProcessorFeatures => ArrayRef[L<Paws::RDS::ProcessorFeature>] | ||
| 561 | |||
| 562 | The number of CPU cores and the number of threads per core for the DB | ||
| 563 | instance class of the DB instance. | ||
| 564 | |||
| 565 | |||
| 566 | |||
| 567 | =head2 PubliclyAccessible => Bool | ||
| 568 | |||
| 569 | A value that indicates whether the DB instance is publicly accessible. | ||
| 570 | |||
| 571 | When the DB instance is publicly accessible, its DNS endpoint resolves | ||
| 572 | to the private IP address from within the DB instance's VPC, and to the | ||
| 573 | public IP address from outside of the DB instance's VPC. Access to the | ||
| 574 | DB instance is ultimately controlled by the security group it uses, and | ||
| 575 | that public access is not permitted if the security group assigned to | ||
| 576 | the DB instance doesn't permit it. | ||
| 577 | |||
| 578 | When the DB instance isn't publicly accessible, it is an internal DB | ||
| 579 | instance with a DNS name that resolves to a private IP address. | ||
| 580 | |||
| 581 | For more information, see CreateDBInstance. | ||
| 582 | |||
| 583 | |||
| 584 | |||
| 585 | =head2 B<REQUIRED> S3BucketName => Str | ||
| 586 | |||
| 587 | The name of your Amazon S3 bucket that contains your database backup | ||
| 588 | file. | ||
| 589 | |||
| 590 | |||
| 591 | |||
| 592 | =head2 B<REQUIRED> S3IngestionRoleArn => Str | ||
| 593 | |||
| 594 | An Amazon Web Services Identity and Access Management (IAM) role to | ||
| 595 | allow Amazon RDS to access your Amazon S3 bucket. | ||
| 596 | |||
| 597 | |||
| 598 | |||
| 599 | =head2 S3Prefix => Str | ||
| 600 | |||
| 601 | The prefix of your Amazon S3 bucket. | ||
| 602 | |||
| 603 | |||
| 604 | |||
| 605 | =head2 B<REQUIRED> SourceEngine => Str | ||
| 606 | |||
| 607 | The name of the engine of your source database. | ||
| 608 | |||
| 609 | Valid Values: C<mysql> | ||
| 610 | |||
| 611 | |||
| 612 | |||
| 613 | =head2 B<REQUIRED> SourceEngineVersion => Str | ||
| 614 | |||
| 615 | The version of the database that the backup files were created from. | ||
| 616 | |||
| 617 | MySQL versions 5.6 and 5.7 are supported. | ||
| 618 | |||
| 619 | Example: C<5.6.40> | ||
| 620 | |||
| 621 | |||
| 622 | |||
| 623 | =head2 StorageEncrypted => Bool | ||
| 624 | |||
| 625 | A value that indicates whether the new DB instance is encrypted or not. | ||
| 626 | |||
| 627 | |||
| 628 | |||
| 629 | =head2 StorageType => Str | ||
| 630 | |||
| 631 | Specifies the storage type to be associated with the DB instance. | ||
| 632 | |||
| 633 | Valid values: C<standard> | C<gp2> | C<io1> | ||
| 634 | |||
| 635 | If you specify C<io1>, you must also include a value for the C<Iops> | ||
| 636 | parameter. | ||
| 637 | |||
| 638 | Default: C<io1> if the C<Iops> parameter is specified; otherwise C<gp2> | ||
| 639 | |||
| 640 | |||
| 641 | |||
| 642 | =head2 Tags => ArrayRef[L<Paws::RDS::Tag>] | ||
| 643 | |||
| 644 | A list of tags to associate with this DB instance. For more | ||
| 645 | information, see Tagging Amazon RDS Resources | ||
| 646 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) | ||
| 647 | in the I<Amazon RDS User Guide.> | ||
| 648 | |||
| 649 | |||
| 650 | |||
| 651 | =head2 UseDefaultProcessorFeatures => Bool | ||
| 652 | |||
| 653 | A value that indicates whether the DB instance class of the DB instance | ||
| 654 | uses its default processor features. | ||
| 655 | |||
| 656 | |||
| 657 | |||
| 658 | =head2 VpcSecurityGroupIds => ArrayRef[Str|Undef] | ||
| 659 | |||
| 660 | A list of VPC security groups to associate with this DB instance. | ||
| 661 | |||
| 662 | |||
| 663 | |||
| 664 | |||
| 665 | =head1 SEE ALSO | ||
| 666 | |||
| 667 | This class forms part of L<Paws>, documenting arguments for method RestoreDBInstanceFromS3 in L<Paws::RDS> | ||
| 668 | |||
| 669 | =head1 BUGS and CONTRIBUTIONS | ||
| 670 | |||
| 671 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 672 | |||
| 673 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 674 | |||
| 675 | =cut | ||
| 676 |