/ 
Paws-0.43
River stage two • 11 direct dependents • 13 total dependents
⭐ Starred 171 GitHub stars
/ Paws::RDS::RestoreDBInstanceFromS3

NAME

Paws::RDS::RestoreDBInstanceFromS3 - Arguments for method RestoreDBInstanceFromS3 on Paws::RDS

DESCRIPTION

This class represents the parameters used for calling the method RestoreDBInstanceFromS3 on the Amazon Relational Database Service service. Use the attributes of this class as arguments to method RestoreDBInstanceFromS3.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RestoreDBInstanceFromS3.

SYNOPSIS

my $rds = Paws->service('RDS');
my $RestoreDBInstanceFromS3Result = $rds->RestoreDBInstanceFromS3(
  DBInstanceClass                    => 'MyString',
  DBInstanceIdentifier               => 'MyString',
  Engine                             => 'MyString',
  S3BucketName                       => 'MyString',
  S3IngestionRoleArn                 => 'MyString',
  SourceEngine                       => 'MyString',
  SourceEngineVersion                => 'MyString',
  AllocatedStorage                   => 1,                      # OPTIONAL
  AutoMinorVersionUpgrade            => 1,                      # OPTIONAL
  AvailabilityZone                   => 'MyString',             # OPTIONAL
  BackupRetentionPeriod              => 1,                      # OPTIONAL
  CopyTagsToSnapshot                 => 1,                      # OPTIONAL
  DBName                             => 'MyString',             # OPTIONAL
  DBParameterGroupName               => 'MyString',             # OPTIONAL
  DBSecurityGroups                   => [ 'MyString', ... ],    # OPTIONAL
  DBSubnetGroupName                  => 'MyString',             # OPTIONAL
  DeletionProtection                 => 1,                      # OPTIONAL
  EnableCloudwatchLogsExports        => [ 'MyString', ... ],    # OPTIONAL
  EnableIAMDatabaseAuthentication    => 1,                      # OPTIONAL
  EnablePerformanceInsights          => 1,                      # OPTIONAL
  EngineVersion                      => 'MyString',             # OPTIONAL
  Iops                               => 1,                      # OPTIONAL
  KmsKeyId                           => 'MyString',             # OPTIONAL
  LicenseModel                       => 'MyString',             # OPTIONAL
  MasterUserPassword                 => 'MyString',             # OPTIONAL
  MasterUsername                     => 'MyString',             # OPTIONAL
  MonitoringInterval                 => 1,                      # OPTIONAL
  MonitoringRoleArn                  => 'MyString',             # OPTIONAL
  MultiAZ                            => 1,                      # OPTIONAL
  OptionGroupName                    => 'MyString',             # OPTIONAL
  PerformanceInsightsKMSKeyId        => 'MyString',             # OPTIONAL
  PerformanceInsightsRetentionPeriod => 1,                      # OPTIONAL
  Port                               => 1,                      # OPTIONAL
  PreferredBackupWindow              => 'MyString',             # OPTIONAL
  PreferredMaintenanceWindow         => 'MyString',             # OPTIONAL
  ProcessorFeatures                  => [
    {
      Name  => 'MyString',
      Value => 'MyString',
    },
    ...
  ],                                                            # OPTIONAL
  PubliclyAccessible => 1,                                      # OPTIONAL
  S3Prefix           => 'MyString',                             # OPTIONAL
  StorageEncrypted   => 1,                                      # OPTIONAL
  StorageType        => 'MyString',                             # OPTIONAL
  Tags               => [
    {
      Key   => 'MyString',
      Value => 'MyString',
    },
    ...
  ],                                                            # OPTIONAL
  UseDefaultProcessorFeatures => 1,                             # OPTIONAL
  VpcSecurityGroupIds         => [ 'MyString', ... ],           # OPTIONAL
);

# Results:
my $DBInstance = $RestoreDBInstanceFromS3Result->DBInstance;

# Returns a L<Paws::RDS::RestoreDBInstanceFromS3Result> object.

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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/rds/RestoreDBInstanceFromS3

ATTRIBUTES

AllocatedStorage => Int

The amount of storage (in gigabytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.

Be sure to allocate enough memory for your new DB instance so that the restore operation can succeed. You can also allocate additional memory for future growth.

AutoMinorVersionUpgrade => Bool

A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are not applied automatically.

AvailabilityZone => Str

The Availability Zone that the DB instance is created in. For information about AWS Regions and Availability Zones, see Regions and Availability Zones (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html) in the Amazon RDS User Guide.

Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.

Example: us-east-1d

Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same AWS Region as the current endpoint.

BackupRetentionPeriod => Int

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. For more information, see CreateDBInstance.

CopyTagsToSnapshot => Bool

A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

REQUIRED DBInstanceClass => Str

The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the Amazon RDS User Guide.

Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class.

REQUIRED DBInstanceIdentifier => Str

The DB instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

DBName => Str

The name of the database to create when the DB instance is created. Follow the naming rules specified in CreateDBInstance.

DBParameterGroupName => Str

The name of the DB parameter group to associate with this DB instance.

If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB engine is used.

DBSecurityGroups => ArrayRef[Str|Undef]

A list of DB security groups to associate with this DB instance.

Default: The default DB security group for the database engine.

DBSubnetGroupName => Str

A DB subnet group to associate with this DB instance.

DeletionProtection => Bool

A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html).

EnableCloudwatchLogsExports => ArrayRef[Str|Undef]

The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the Amazon RDS User Guide.

EnableIAMDatabaseAuthentication => Bool

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For information about the supported DB engines, see CreateDBInstance.

For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the Amazon RDS User Guide.

EnablePerformanceInsights => Bool

A value that indicates whether to enable Performance Insights for the DB instance.

For more information, see Using Amazon Performance Insights (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the Amazon Relational Database Service User Guide.

REQUIRED Engine => Str

The name of the database engine to be used for this instance.

Valid Values: mysql

EngineVersion => Str

The version number of the database engine to use. Choose the latest minor version of your database engine. For information about engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.

Iops => Int

The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance. For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) in the Amazon RDS User Guide.

KmsKeyId => Str

The AWS KMS key identifier for an encrypted DB instance.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.

If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

LicenseModel => Str

The license model for this DB instance. Use general-public-license.

MasterUsername => Str

The name for the master user.

Constraints:

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

  • Can't be a reserved word for the chosen database engine.

MasterUserPassword => Str

The password for the master user. The password can include any printable ASCII character except "/", """, or "@".

Constraints: Must contain from 8 to 41 characters.

MonitoringInterval => Int

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0.

If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

Valid Values: 0, 1, 5, 10, 15, 30, 60

Default: 0

MonitoringRoleArn => Str

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

MultiAZ => Bool

A value that indicates whether the DB instance is a Multi-AZ deployment. If the DB instance is a Multi-AZ deployment, you can't set the AvailabilityZone parameter.

OptionGroupName => Str

The name of the option group to associate with this DB instance. If this argument is omitted, the default option group for the specified engine is used.

PerformanceInsightsKMSKeyId => Str

The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key.

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

PerformanceInsightsRetentionPeriod => Int

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

Port => Int

The port number on which the database accepts connections.

Type: Integer

Valid Values: 1150-65535

Default: 3306

PreferredBackupWindow => Str

The time range each day during which automated backups are created if automated backups are enabled. For more information, see The Backup Window (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) in the Amazon RDS User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

PreferredMaintenanceWindow => Str

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance) in the Amazon RDS User Guide.

Constraints:

  • Must be in the format ddd:hh24:mi-ddd:hh24:mi.

  • Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred backup window.

  • Must be at least 30 minutes.

ProcessorFeatures => ArrayRef[Paws::RDS::ProcessorFeature]

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

PubliclyAccessible => Bool

A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance isn't publicly accessible, it is an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.

REQUIRED S3BucketName => Str

The name of your Amazon S3 bucket that contains your database backup file.

REQUIRED S3IngestionRoleArn => Str

An AWS Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.

S3Prefix => Str

The prefix of your Amazon S3 bucket.

REQUIRED SourceEngine => Str

The name of the engine of your source database.

Valid Values: mysql

REQUIRED SourceEngineVersion => Str

The engine version of your source database.

Valid Values: 5.6

StorageEncrypted => Bool

A value that indicates whether the new DB instance is encrypted or not.

StorageType => Str

Specifies the storage type to be associated with the DB instance.

Valid values: standard | gp2 | io1

If you specify io1, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified; otherwise gp2

Tags => ArrayRef[Paws::RDS::Tag]

A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the Amazon RDS User Guide.

UseDefaultProcessorFeatures => Bool

A value that indicates whether the DB instance class of the DB instance uses its default processor features.

VpcSecurityGroupIds => ArrayRef[Str|Undef]

A list of VPC security groups to associate with this DB instance.

SEE ALSO

This class forms part of Paws, documenting arguments for method RestoreDBInstanceFromS3 in Paws::RDS

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues