NAME
Paws::RDS::RestoreDBClusterFromSnapshot - Arguments for method RestoreDBClusterFromSnapshot on Paws::RDS
DESCRIPTION
This class represents the parameters used for calling the method RestoreDBClusterFromSnapshot on the Amazon Relational Database Service service. Use the attributes of this class as arguments to method RestoreDBClusterFromSnapshot.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RestoreDBClusterFromSnapshot.
SYNOPSIS
my $rds = Paws->service('RDS');
# To restore an Amazon Aurora DB cluster from a DB cluster snapshot
# The following example restores an Amazon Aurora DB cluster from a DB cluster
# snapshot.
my $RestoreDBClusterFromSnapshotResult = $rds->RestoreDBClusterFromSnapshot(
'DBClusterIdentifier' => 'restored-cluster1',
'Engine' => 'aurora',
'SnapshotIdentifier' => 'sample-cluster-snapshot1'
);
# Results:
my $DBCluster = $RestoreDBClusterFromSnapshotResult->DBCluster;
# Returns a L<Paws::RDS::RestoreDBClusterFromSnapshotResult> 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/RestoreDBClusterFromSnapshot
ATTRIBUTES
AvailabilityZones => ArrayRef[Str|Undef]
Provides the 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).
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 DB snapshot or DB cluster snapshot. 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-snapshot-id
DBClusterParameterGroupName => Str
The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.
Constraints:
If supplied, must match the name of an existing default DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
DBSubnetGroupName => Str
The name of the DB subnet group to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DB subnet group.
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. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
For more information, see Kerberos Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) in the Amazon RDS 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 Amazon 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 database engine to use for the new DB cluster.
Default: The same as source
Constraint: Must be compatible with the engine of the source
EngineMode => Str
The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.
For more information, see CreateDBCluster (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html).
EngineVersion => Str
The version of the database engine to use for the new DB cluster.
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"
If you aren't using the default engine version, then you must specify the engine version.
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 to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.
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.
When you don't specify a value for the KmsKeyId parameter, then the following occurs:
If the DB snapshot or DB cluster snapshot in
SnapshotIdentifieris encrypted, then the restored DB cluster is encrypted using the Amazon Web Services KMS CMK that was used to encrypt the DB snapshot or DB cluster snapshot.If the DB snapshot or DB cluster snapshot in
SnapshotIdentifierisn't encrypted, then the restored DB cluster isn't encrypted.
OptionGroupName => Str
The name of the option group to use for the restored DB cluster.
Port => Int
The port number on which the new DB cluster accepts connections.
Constraints: This value must be 1150-65535
Default: The same port as the original DB cluster.
ScalingConfiguration => Paws::RDS::ScalingConfiguration
For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
REQUIRED SnapshotIdentifier => Str
The identifier for the DB snapshot or DB cluster snapshot to restore from.
You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
Constraints:
Must match the identifier of an existing Snapshot.
Tags => ArrayRef[Paws::RDS::Tag]
The tags to be assigned to the restored DB cluster.
VpcSecurityGroupIds => ArrayRef[Str|Undef]
A list of VPC security groups that the new DB cluster will belong to.
SEE ALSO
This class forms part of Paws, documenting arguments for method RestoreDBClusterFromSnapshot 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