Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
The target DB cluster is created from the source snapshot with a default configuration. If you don't specify a security group, the new DB cluster is associated with the default security group.
This action only restores the DB cluster, not the DB instances for that
DB cluster. You must invoke the CreateDBInstance
action to create DB
instances for the restored DB cluster, specifying the identifier of the
restored DB cluster in DBClusterIdentifier
. You can create DB
instances only after the RestoreDBClusterFromSnapshot
action has
completed and the DB cluster is available.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
Synopsis
- data RestoreDBClusterFromSnapshot = RestoreDBClusterFromSnapshot' {
- availabilityZones :: Maybe [Text]
- backtrackWindow :: Maybe Integer
- copyTagsToSnapshot :: Maybe Bool
- dbClusterInstanceClass :: Maybe Text
- dbClusterParameterGroupName :: Maybe Text
- dbSubnetGroupName :: Maybe Text
- databaseName :: Maybe Text
- deletionProtection :: Maybe Bool
- domain :: Maybe Text
- domainIAMRoleName :: Maybe Text
- enableCloudwatchLogsExports :: Maybe [Text]
- enableIAMDatabaseAuthentication :: Maybe Bool
- engineMode :: Maybe Text
- engineVersion :: Maybe Text
- iops :: Maybe Int
- kmsKeyId :: Maybe Text
- networkType :: Maybe Text
- optionGroupName :: Maybe Text
- port :: Maybe Int
- publiclyAccessible :: Maybe Bool
- scalingConfiguration :: Maybe ScalingConfiguration
- serverlessV2ScalingConfiguration :: Maybe ServerlessV2ScalingConfiguration
- storageType :: Maybe Text
- tags :: Maybe [Tag]
- vpcSecurityGroupIds :: Maybe [Text]
- dbClusterIdentifier :: Text
- snapshotIdentifier :: Text
- engine :: Text
- newRestoreDBClusterFromSnapshot :: Text -> Text -> Text -> RestoreDBClusterFromSnapshot
- restoreDBClusterFromSnapshot_availabilityZones :: Lens' RestoreDBClusterFromSnapshot (Maybe [Text])
- restoreDBClusterFromSnapshot_backtrackWindow :: Lens' RestoreDBClusterFromSnapshot (Maybe Integer)
- restoreDBClusterFromSnapshot_copyTagsToSnapshot :: Lens' RestoreDBClusterFromSnapshot (Maybe Bool)
- restoreDBClusterFromSnapshot_dbClusterInstanceClass :: Lens' RestoreDBClusterFromSnapshot (Maybe Text)
- restoreDBClusterFromSnapshot_dbClusterParameterGroupName :: Lens' RestoreDBClusterFromSnapshot (Maybe Text)
- restoreDBClusterFromSnapshot_dbSubnetGroupName :: Lens' RestoreDBClusterFromSnapshot (Maybe Text)
- restoreDBClusterFromSnapshot_databaseName :: Lens' RestoreDBClusterFromSnapshot (Maybe Text)
- restoreDBClusterFromSnapshot_deletionProtection :: Lens' RestoreDBClusterFromSnapshot (Maybe Bool)
- restoreDBClusterFromSnapshot_domain :: Lens' RestoreDBClusterFromSnapshot (Maybe Text)
- restoreDBClusterFromSnapshot_domainIAMRoleName :: Lens' RestoreDBClusterFromSnapshot (Maybe Text)
- restoreDBClusterFromSnapshot_enableCloudwatchLogsExports :: Lens' RestoreDBClusterFromSnapshot (Maybe [Text])
- restoreDBClusterFromSnapshot_enableIAMDatabaseAuthentication :: Lens' RestoreDBClusterFromSnapshot (Maybe Bool)
- restoreDBClusterFromSnapshot_engineMode :: Lens' RestoreDBClusterFromSnapshot (Maybe Text)
- restoreDBClusterFromSnapshot_engineVersion :: Lens' RestoreDBClusterFromSnapshot (Maybe Text)
- restoreDBClusterFromSnapshot_iops :: Lens' RestoreDBClusterFromSnapshot (Maybe Int)
- restoreDBClusterFromSnapshot_kmsKeyId :: Lens' RestoreDBClusterFromSnapshot (Maybe Text)
- restoreDBClusterFromSnapshot_networkType :: Lens' RestoreDBClusterFromSnapshot (Maybe Text)
- restoreDBClusterFromSnapshot_optionGroupName :: Lens' RestoreDBClusterFromSnapshot (Maybe Text)
- restoreDBClusterFromSnapshot_port :: Lens' RestoreDBClusterFromSnapshot (Maybe Int)
- restoreDBClusterFromSnapshot_publiclyAccessible :: Lens' RestoreDBClusterFromSnapshot (Maybe Bool)
- restoreDBClusterFromSnapshot_scalingConfiguration :: Lens' RestoreDBClusterFromSnapshot (Maybe ScalingConfiguration)
- restoreDBClusterFromSnapshot_serverlessV2ScalingConfiguration :: Lens' RestoreDBClusterFromSnapshot (Maybe ServerlessV2ScalingConfiguration)
- restoreDBClusterFromSnapshot_storageType :: Lens' RestoreDBClusterFromSnapshot (Maybe Text)
- restoreDBClusterFromSnapshot_tags :: Lens' RestoreDBClusterFromSnapshot (Maybe [Tag])
- restoreDBClusterFromSnapshot_vpcSecurityGroupIds :: Lens' RestoreDBClusterFromSnapshot (Maybe [Text])
- restoreDBClusterFromSnapshot_dbClusterIdentifier :: Lens' RestoreDBClusterFromSnapshot Text
- restoreDBClusterFromSnapshot_snapshotIdentifier :: Lens' RestoreDBClusterFromSnapshot Text
- restoreDBClusterFromSnapshot_engine :: Lens' RestoreDBClusterFromSnapshot Text
- data RestoreDBClusterFromSnapshotResponse = RestoreDBClusterFromSnapshotResponse' {
- dbCluster :: Maybe DBCluster
- httpStatus :: Int
- newRestoreDBClusterFromSnapshotResponse :: Int -> RestoreDBClusterFromSnapshotResponse
- restoreDBClusterFromSnapshotResponse_dbCluster :: Lens' RestoreDBClusterFromSnapshotResponse (Maybe DBCluster)
- restoreDBClusterFromSnapshotResponse_httpStatus :: Lens' RestoreDBClusterFromSnapshotResponse Int
Creating a Request
data RestoreDBClusterFromSnapshot Source #
See: newRestoreDBClusterFromSnapshot
smart constructor.
RestoreDBClusterFromSnapshot' | |
|
Instances
newRestoreDBClusterFromSnapshot Source #
:: Text | |
-> Text | |
-> Text | |
-> RestoreDBClusterFromSnapshot |
Create a value of RestoreDBClusterFromSnapshot
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
RestoreDBClusterFromSnapshot
, restoreDBClusterFromSnapshot_availabilityZones
- Provides the list of Availability Zones (AZs) where instances in the
restored DB cluster can be created.
Valid for: Aurora DB clusters only
RestoreDBClusterFromSnapshot
, restoreDBClusterFromSnapshot_backtrackWindow
- 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).
Valid for: Aurora DB clusters only
RestoreDBClusterFromSnapshot
, restoreDBClusterFromSnapshot_copyTagsToSnapshot
- 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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
RestoreDBClusterFromSnapshot
, restoreDBClusterFromSnapshot_dbClusterInstanceClass
- The compute and memory capacity of the each DB instance in the Multi-AZ
DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are
available in all Amazon Web Services Regions, or for all database
engines.
For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Valid for: Multi-AZ DB clusters only
RestoreDBClusterFromSnapshot
, restoreDBClusterFromSnapshot_dbClusterParameterGroupName
- 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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
RestoreDBClusterFromSnapshot
, restoreDBClusterFromSnapshot_dbSubnetGroupName
- 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: mydbsubnetgroup
Valid for: Aurora DB clusters and Multi-AZ DB clusters
RestoreDBClusterFromSnapshot
, restoreDBClusterFromSnapshot_databaseName
- The database name for the restored DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
RestoreDBClusterFromSnapshot
, restoreDBClusterFromSnapshot_deletionProtection
- 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 isn't enabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
RestoreDBClusterFromSnapshot
, restoreDBClusterFromSnapshot_domain
- 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 in the Amazon RDS User Guide.
Valid for: Aurora DB clusters only
$sel:domainIAMRoleName:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_domainIAMRoleName
- Specify the name of the IAM role to be used when making API calls to the
Directory Service.
Valid for: Aurora DB clusters only
$sel:enableCloudwatchLogsExports:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_enableCloudwatchLogsExports
- 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.
RDS for MySQL
Possible values are error
, general
, and slowquery
.
RDS for PostgreSQL
Possible values are postgresql
and upgrade
.
Aurora MySQL
Possible values are audit
, error
, general
, and slowquery
.
Aurora PostgreSQL
Possible value is postgresql
.
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
$sel:enableIAMDatabaseAuthentication:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_enableIAMDatabaseAuthentication
- A value that indicates whether to enable mapping of Amazon Web Services
Identity and Access Management (IAM) accounts to database accounts. By
default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
RestoreDBClusterFromSnapshot
, restoreDBClusterFromSnapshot_engineMode
- The DB engine mode of the DB cluster, either provisioned
,
serverless
, parallelquery
, global
, or multimaster
.
For more information, see CreateDBCluster.
Valid for: Aurora DB clusters only
RestoreDBClusterFromSnapshot
, restoreDBClusterFromSnapshot_engineVersion
- The version of the database engine to use for the new DB cluster.
To list all of the available engine versions 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 MySQL 5.7-compatible and MySQL 8.0-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"
To list all of the available engine versions for RDS for MySQL, use the following command:
aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"
Aurora MySQL
See MySQL on Amazon RDS Versions in the Amazon Aurora User Guide.
Aurora PostgreSQL
See Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide.
MySQL
See MySQL on Amazon RDS Versions in the Amazon RDS User Guide.
PostgreSQL
See Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
RestoreDBClusterFromSnapshot
, restoreDBClusterFromSnapshot_iops
- The amount of Provisioned IOPS (input/output operations per second) to
be initially allocated for each DB instance in the Multi-AZ DB cluster.
For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
RestoreDBClusterFromSnapshot
, restoreDBClusterFromSnapshot_kmsKeyId
- 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 KMS key. To use a KMS key 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
SnapshotIdentifier
is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot. - If the DB snapshot or DB cluster snapshot in
SnapshotIdentifier
isn't encrypted, then the restored DB cluster isn't encrypted.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
RestoreDBClusterFromSnapshot
, restoreDBClusterFromSnapshot_networkType
- The network type of the DB cluster.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup
specified for the
DB cluster. A DBSubnetGroup
can support only the IPv4 protocol or the
IPv4 and the IPv6 protocols (DUAL
).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
RestoreDBClusterFromSnapshot
, restoreDBClusterFromSnapshot_optionGroupName
- The name of the option group to use for the restored DB cluster.
DB clusters are associated with a default option group that can't be modified.
RestoreDBClusterFromSnapshot
, restoreDBClusterFromSnapshot_port
- 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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
RestoreDBClusterFromSnapshot
, restoreDBClusterFromSnapshot_publiclyAccessible
- A value that indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether
DBSubnetGroupName
is specified.
If DBSubnetGroupName
isn't specified, and PubliclyAccessible
isn't
specified, the following applies:
- If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
- If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
If DBSubnetGroupName
is specified, and PubliclyAccessible
isn't
specified, the following applies:
- If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
- If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
$sel:scalingConfiguration:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_scalingConfiguration
- For DB clusters in serverless
DB engine mode, the scaling properties
of the DB cluster.
Valid for: Aurora DB clusters only
RestoreDBClusterFromSnapshot
, restoreDBClusterFromSnapshot_serverlessV2ScalingConfiguration
- Undocumented member.
RestoreDBClusterFromSnapshot
, restoreDBClusterFromSnapshot_storageType
- Specifies the storage type to be associated with the each DB instance in
the Multi-AZ DB cluster.
Valid values: io1
When specified, a value for the Iops
parameter is required.
Default: io1
Valid for: Aurora DB clusters and Multi-AZ DB clusters
$sel:tags:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_tags
- The tags to be assigned to the restored DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
RestoreDBClusterFromSnapshot
, restoreDBClusterFromSnapshot_vpcSecurityGroupIds
- A list of VPC security groups that the new DB cluster will belong to.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
RestoreDBClusterFromSnapshot
, restoreDBClusterFromSnapshot_dbClusterIdentifier
- 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
Valid for: Aurora DB clusters and Multi-AZ DB clusters
$sel:snapshotIdentifier:RestoreDBClusterFromSnapshot'
, restoreDBClusterFromSnapshot_snapshotIdentifier
- 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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
RestoreDBClusterFromSnapshot
, restoreDBClusterFromSnapshot_engine
- 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
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Request Lenses
restoreDBClusterFromSnapshot_availabilityZones :: Lens' RestoreDBClusterFromSnapshot (Maybe [Text]) Source #
Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
Valid for: Aurora DB clusters only
restoreDBClusterFromSnapshot_backtrackWindow :: Lens' RestoreDBClusterFromSnapshot (Maybe Integer) Source #
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).
Valid for: Aurora DB clusters only
restoreDBClusterFromSnapshot_copyTagsToSnapshot :: Lens' RestoreDBClusterFromSnapshot (Maybe Bool) Source #
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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
restoreDBClusterFromSnapshot_dbClusterInstanceClass :: Lens' RestoreDBClusterFromSnapshot (Maybe Text) Source #
The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Valid for: Multi-AZ DB clusters only
restoreDBClusterFromSnapshot_dbClusterParameterGroupName :: Lens' RestoreDBClusterFromSnapshot (Maybe Text) Source #
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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
restoreDBClusterFromSnapshot_dbSubnetGroupName :: Lens' RestoreDBClusterFromSnapshot (Maybe Text) Source #
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: mydbsubnetgroup
Valid for: Aurora DB clusters and Multi-AZ DB clusters
restoreDBClusterFromSnapshot_databaseName :: Lens' RestoreDBClusterFromSnapshot (Maybe Text) Source #
The database name for the restored DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
restoreDBClusterFromSnapshot_deletionProtection :: Lens' RestoreDBClusterFromSnapshot (Maybe Bool) Source #
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 isn't enabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
restoreDBClusterFromSnapshot_domain :: Lens' RestoreDBClusterFromSnapshot (Maybe Text) Source #
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 in the Amazon RDS User Guide.
Valid for: Aurora DB clusters only
restoreDBClusterFromSnapshot_domainIAMRoleName :: Lens' RestoreDBClusterFromSnapshot (Maybe Text) Source #
Specify the name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
restoreDBClusterFromSnapshot_enableCloudwatchLogsExports :: Lens' RestoreDBClusterFromSnapshot (Maybe [Text]) Source #
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.
RDS for MySQL
Possible values are error
, general
, and slowquery
.
RDS for PostgreSQL
Possible values are postgresql
and upgrade
.
Aurora MySQL
Possible values are audit
, error
, general
, and slowquery
.
Aurora PostgreSQL
Possible value is postgresql
.
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
restoreDBClusterFromSnapshot_enableIAMDatabaseAuthentication :: Lens' RestoreDBClusterFromSnapshot (Maybe Bool) Source #
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
restoreDBClusterFromSnapshot_engineMode :: Lens' RestoreDBClusterFromSnapshot (Maybe Text) Source #
The DB engine mode of the DB cluster, either provisioned
,
serverless
, parallelquery
, global
, or multimaster
.
For more information, see CreateDBCluster.
Valid for: Aurora DB clusters only
restoreDBClusterFromSnapshot_engineVersion :: Lens' RestoreDBClusterFromSnapshot (Maybe Text) Source #
The version of the database engine to use for the new DB cluster.
To list all of the available engine versions 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 MySQL 5.7-compatible and MySQL 8.0-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"
To list all of the available engine versions for RDS for MySQL, use the following command:
aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"
Aurora MySQL
See MySQL on Amazon RDS Versions in the Amazon Aurora User Guide.
Aurora PostgreSQL
See Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide.
MySQL
See MySQL on Amazon RDS Versions in the Amazon RDS User Guide.
PostgreSQL
See Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
restoreDBClusterFromSnapshot_iops :: Lens' RestoreDBClusterFromSnapshot (Maybe Int) Source #
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
restoreDBClusterFromSnapshot_kmsKeyId :: Lens' RestoreDBClusterFromSnapshot (Maybe Text) Source #
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 KMS key. To use a KMS key 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
SnapshotIdentifier
is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot. - If the DB snapshot or DB cluster snapshot in
SnapshotIdentifier
isn't encrypted, then the restored DB cluster isn't encrypted.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
restoreDBClusterFromSnapshot_networkType :: Lens' RestoreDBClusterFromSnapshot (Maybe Text) Source #
The network type of the DB cluster.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup
specified for the
DB cluster. A DBSubnetGroup
can support only the IPv4 protocol or the
IPv4 and the IPv6 protocols (DUAL
).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
Valid for: Aurora DB clusters only
restoreDBClusterFromSnapshot_optionGroupName :: Lens' RestoreDBClusterFromSnapshot (Maybe Text) Source #
The name of the option group to use for the restored DB cluster.
DB clusters are associated with a default option group that can't be modified.
restoreDBClusterFromSnapshot_port :: Lens' RestoreDBClusterFromSnapshot (Maybe Int) Source #
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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
restoreDBClusterFromSnapshot_publiclyAccessible :: Lens' RestoreDBClusterFromSnapshot (Maybe Bool) Source #
A value that indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether
DBSubnetGroupName
is specified.
If DBSubnetGroupName
isn't specified, and PubliclyAccessible
isn't
specified, the following applies:
- If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
- If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.
If DBSubnetGroupName
is specified, and PubliclyAccessible
isn't
specified, the following applies:
- If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
- If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
restoreDBClusterFromSnapshot_scalingConfiguration :: Lens' RestoreDBClusterFromSnapshot (Maybe ScalingConfiguration) Source #
For DB clusters in serverless
DB engine mode, the scaling properties
of the DB cluster.
Valid for: Aurora DB clusters only
restoreDBClusterFromSnapshot_serverlessV2ScalingConfiguration :: Lens' RestoreDBClusterFromSnapshot (Maybe ServerlessV2ScalingConfiguration) Source #
Undocumented member.
restoreDBClusterFromSnapshot_storageType :: Lens' RestoreDBClusterFromSnapshot (Maybe Text) Source #
Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.
Valid values: io1
When specified, a value for the Iops
parameter is required.
Default: io1
Valid for: Aurora DB clusters and Multi-AZ DB clusters
restoreDBClusterFromSnapshot_tags :: Lens' RestoreDBClusterFromSnapshot (Maybe [Tag]) Source #
The tags to be assigned to the restored DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
restoreDBClusterFromSnapshot_vpcSecurityGroupIds :: Lens' RestoreDBClusterFromSnapshot (Maybe [Text]) Source #
A list of VPC security groups that the new DB cluster will belong to.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
restoreDBClusterFromSnapshot_dbClusterIdentifier :: Lens' RestoreDBClusterFromSnapshot Text Source #
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
Valid for: Aurora DB clusters and Multi-AZ DB clusters
restoreDBClusterFromSnapshot_snapshotIdentifier :: Lens' RestoreDBClusterFromSnapshot Text Source #
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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
restoreDBClusterFromSnapshot_engine :: Lens' RestoreDBClusterFromSnapshot Text Source #
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
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Destructuring the Response
data RestoreDBClusterFromSnapshotResponse Source #
See: newRestoreDBClusterFromSnapshotResponse
smart constructor.
RestoreDBClusterFromSnapshotResponse' | |
|
Instances
Generic RestoreDBClusterFromSnapshotResponse Source # | |
Read RestoreDBClusterFromSnapshotResponse Source # | |
Show RestoreDBClusterFromSnapshotResponse Source # | |
NFData RestoreDBClusterFromSnapshotResponse Source # | |
Defined in Amazonka.RDS.RestoreDBClusterFromSnapshot rnf :: RestoreDBClusterFromSnapshotResponse -> () # | |
Eq RestoreDBClusterFromSnapshotResponse Source # | |
type Rep RestoreDBClusterFromSnapshotResponse Source # | |
Defined in Amazonka.RDS.RestoreDBClusterFromSnapshot type Rep RestoreDBClusterFromSnapshotResponse = D1 ('MetaData "RestoreDBClusterFromSnapshotResponse" "Amazonka.RDS.RestoreDBClusterFromSnapshot" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "RestoreDBClusterFromSnapshotResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbCluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBCluster)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newRestoreDBClusterFromSnapshotResponse Source #
Create a value of RestoreDBClusterFromSnapshotResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dbCluster:RestoreDBClusterFromSnapshotResponse'
, restoreDBClusterFromSnapshotResponse_dbCluster
- Undocumented member.
$sel:httpStatus:RestoreDBClusterFromSnapshotResponse'
, restoreDBClusterFromSnapshotResponse_httpStatus
- The response's http status code.
Response Lenses
restoreDBClusterFromSnapshotResponse_dbCluster :: Lens' RestoreDBClusterFromSnapshotResponse (Maybe DBCluster) Source #
Undocumented member.
restoreDBClusterFromSnapshotResponse_httpStatus :: Lens' RestoreDBClusterFromSnapshotResponse Int Source #
The response's http status code.