NAME
Paws::RDS::RestoreDBClusterFromS3 - Arguments for method RestoreDBClusterFromS3 on Paws::RDS
DESCRIPTION
This class represents the parameters used for calling the method RestoreDBClusterFromS3 on the Amazon Relational Database Service service. Use the attributes of this class as arguments to method RestoreDBClusterFromS3.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RestoreDBClusterFromS3.
As an example:
$service_obj->RestoreDBClusterFromS3(Att1 => $value1, Att2 => $value2, ...);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.
ATTRIBUTES
AvailabilityZones => ArrayRef[Str|Undef]
A list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
BackupRetentionPeriod => Int
The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.
Default: 1
Constraints:
Must be a value from 1 to 35
CharacterSetName => Str
A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.
DatabaseName => Str
The database name for the restored DB cluster.
REQUIRED DBClusterIdentifier => Str
The name of the DB cluster to create from the source data in the S3 bucket. This parameter is isn't case-sensitive.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
DBClusterParameterGroupName => Str
The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, default.aurora5.6 will be used.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
DBSubnetGroupName => Str
A DB subnet group to associate with the restored DB cluster.
Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example: mySubnetgroup
EnableIAMDatabaseAuthentication => Bool
A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default: false
REQUIRED Engine => Str
The name of the database engine to be used for the restored DB cluster.
Valid Values: aurora
EngineVersion => Str
The version number of the database engine to use.
Aurora
Example: 5.6.10a
KmsKeyId => Str
The KMS key identifier for an encrypted DB cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KM encryption key.
If the StorageEncrypted parameter is true, 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.
REQUIRED MasterUsername => Str
The name of the master user for the restored DB cluster.
Constraints:
Must be 1 to 16 alphanumeric characters.
First character must be a letter.
Cannot be a reserved word for the chosen database engine.
REQUIRED MasterUserPassword => Str
The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".
Constraints: Must contain from 8 to 41 characters.
OptionGroupName => Str
A value that indicates that the restored DB cluster should be associated with the specified option group.
Permanent options cannot be removed from an option group. An option group cannot be removed from a DB cluster once it is associated with a DB cluster.
Port => Int
The port number on which the instances in the restored DB cluster accept connections.
Default: 3306
PreferredBackupWindow => Str
The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.
Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
Must be in the format
hh24:mi-hh24:mi.Times should be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
PreferredMaintenanceWindow => Str
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
REQUIRED S3BucketName => Str
The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.
REQUIRED S3IngestionRoleArn => Str
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.
S3Prefix => Str
The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using all of the files in the Amazon S3 bucket.
REQUIRED SourceEngine => Str
The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.
Valid values: mysql
REQUIRED SourceEngineVersion => Str
The version of the database that the backup files were created from.
MySQL version 5.5 and 5.6 are supported.
Example: 5.6.22
StorageEncrypted => Bool
Specifies whether the restored DB cluster is encrypted.
Tags => ArrayRef[Paws::RDS::Tag]
VpcSecurityGroupIds => ArrayRef[Str|Undef]
A list of EC2 VPC security groups to associate with the restored DB cluster.
SEE ALSO
This class forms part of Paws, documenting arguments for method RestoreDBClusterFromS3 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