/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::RDS::RestoreDBClusterFromS3

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.

SYNOPSIS

my $rds = Paws->service('RDS');
my $RestoreDBClusterFromS3Result = $rds->RestoreDBClusterFromS3(
  DBClusterIdentifier             => 'MyString',
  Engine                          => 'MyString',
  MasterUserPassword              => 'MyString',
  MasterUsername                  => 'MyString',
  S3BucketName                    => 'MyString',
  S3IngestionRoleArn              => 'MyString',
  SourceEngine                    => 'MyString',
  SourceEngineVersion             => 'MyString',
  AvailabilityZones               => [ 'MyString', ... ],    # OPTIONAL
  BacktrackWindow                 => 1,                      # OPTIONAL
  BackupRetentionPeriod           => 1,                      # OPTIONAL
  CharacterSetName                => 'MyString',             # OPTIONAL
  CopyTagsToSnapshot              => 1,                      # OPTIONAL
  DBClusterParameterGroupName     => 'MyString',             # OPTIONAL
  DBSubnetGroupName               => 'MyString',             # OPTIONAL
  DatabaseName                    => 'MyString',             # OPTIONAL
  DeletionProtection              => 1,                      # OPTIONAL
  Domain                          => 'MyString',             # OPTIONAL
  DomainIAMRoleName               => 'MyString',             # OPTIONAL
  EnableCloudwatchLogsExports     => [ 'MyString', ... ],    # OPTIONAL
  EnableIAMDatabaseAuthentication => 1,                      # OPTIONAL
  EngineVersion                   => 'MyString',             # OPTIONAL
  KmsKeyId                        => 'MyString',             # OPTIONAL
  OptionGroupName                 => 'MyString',             # OPTIONAL
  Port                            => 1,                      # OPTIONAL
  PreferredBackupWindow           => 'MyString',             # OPTIONAL
  PreferredMaintenanceWindow      => 'MyString',             # OPTIONAL
  S3Prefix                        => 'MyString',             # OPTIONAL
  StorageEncrypted                => 1,                      # OPTIONAL
  Tags                            => [
    {
      Key   => 'MyString',
      Value => 'MyString',
    },
    ...
  ],                                                         # OPTIONAL
  VpcSecurityGroupIds => [ 'MyString', ... ],                # OPTIONAL
);

# Results:
my $DBCluster = $RestoreDBClusterFromS3Result->DBCluster;

# Returns a L<Paws::RDS::RestoreDBClusterFromS3Result> 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/RestoreDBClusterFromS3

ATTRIBUTES

AvailabilityZones => ArrayRef[Str|Undef]

A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.

BacktrackWindow => Int

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Currently, Backtrack is only supported for Aurora MySQL DB clusters.

Default: 0

Constraints:

  • If specified, this value must be set to a number from 0 to 259,200 (72 hours).

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.

CopyTagsToSnapshot => Bool

A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

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 Amazon S3 bucket. This parameter isn't case-sensitive.

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: 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 is used.

Constraints:

  • If supplied, must match the name of an existing DBClusterParameterGroup.

DBSubnetGroupName => Str

A DB subnet group to associate with the restored DB cluster.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

DeletionProtection => Bool

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

Domain => Str

Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html) in the Amazon Aurora User Guide.

DomainIAMRoleName => Str

Specify the name of the IAM role to be used when making API calls to the Directory Service.

EnableCloudwatchLogsExports => ArrayRef[Str|Undef]

The list of logs that the restored DB cluster 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/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the Amazon Aurora User Guide.

EnableIAMDatabaseAuthentication => Bool

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

For more information, see IAM Database Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) in the Amazon Aurora User Guide.

REQUIRED Engine => Str

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

Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql

EngineVersion => Str

The version number of the database engine to use.

To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:

aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for aurora-postgresql, use the following command:

aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"

Aurora MySQL

Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5

Aurora PostgreSQL

Example: 9.6.3, 10.7

KmsKeyId => Str

The Amazon Web Services KMS key identifier for an encrypted DB cluster.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK). To use a CMK in a different Amazon Web Services account, specify the key ARN or alias ARN.

If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default CMK. There is a default CMK for your Amazon Web Services account. Your Amazon Web Services account has a different default CMK for each Amazon Web Services Region.

REQUIRED MasterUsername => Str

The name of the master user for the restored DB cluster.

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.

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 can't be removed from an option group. An option group can't 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.

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see Backup window (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow) in the Amazon Aurora 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 weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora) in the Amazon Aurora 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 Amazon Web Services 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 versions 5.5, 5.6, and 5.7 are supported.

Example: 5.6.40, 5.7.28

StorageEncrypted => Bool

A value that indicates 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