rds_create_db_cluster: Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster
In paws.database: 'Amazon Web Services' Database Services
View source: R/rds_operations.R
rds_create_db_cluster R Documentation
Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster
Description
Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.
See https://www.paws-r-sdk.com/docs/rds_create_db_cluster/ for full documentation.
Usage
rds_create_db_cluster(
AvailabilityZones = NULL,
BackupRetentionPeriod = NULL,
CharacterSetName = NULL,
DatabaseName = NULL,
DBClusterIdentifier,
DBClusterParameterGroupName = NULL,
VpcSecurityGroupIds = NULL,
DBSubnetGroupName = NULL,
Engine,
EngineVersion = NULL,
Port = NULL,
MasterUsername = NULL,
MasterUserPassword = NULL,
OptionGroupName = NULL,
PreferredBackupWindow = NULL,
PreferredMaintenanceWindow = NULL,
ReplicationSourceIdentifier = NULL,
Tags = NULL,
StorageEncrypted = NULL,
KmsKeyId = NULL,
PreSignedUrl = NULL,
EnableIAMDatabaseAuthentication = NULL,
BacktrackWindow = NULL,
EnableCloudwatchLogsExports = NULL,
EngineMode = NULL,
ScalingConfiguration = NULL,
DeletionProtection = NULL,
GlobalClusterIdentifier = NULL,
EnableHttpEndpoint = NULL,
CopyTagsToSnapshot = NULL,
Domain = NULL,
DomainIAMRoleName = NULL,
EnableGlobalWriteForwarding = NULL,
DBClusterInstanceClass = NULL,
AllocatedStorage = NULL,
StorageType = NULL,
Iops = NULL,
PubliclyAccessible = NULL,
AutoMinorVersionUpgrade = NULL,
MonitoringInterval = NULL,
MonitoringRoleArn = NULL,
EnablePerformanceInsights = NULL,
PerformanceInsightsKMSKeyId = NULL,
PerformanceInsightsRetentionPeriod = NULL,
ServerlessV2ScalingConfiguration = NULL,
NetworkType = NULL,
DBSystemId = NULL,
ManageMasterUserPassword = NULL,
MasterUserSecretKmsKeyId = NULL,
EnableLocalWriteForwarding = NULL,
SourceRegion = NULL
)
Arguments
AvailabilityZones
A list of Availability Zones (AZs) where DB instances in the DB cluster
can be created.
For information on Amazon Web Services Regions and Availability Zones,
see Choosing the Regions and Availability Zones
in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
BackupRetentionPeriod
The number of days for which automated backups are retained.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Default: 1
Constraints:
Must be a value from 1 to 35.
CharacterSetName
The name of the character set (CharacterSet) to associate the DB
cluster with.
Valid for Cluster Type: Aurora DB clusters only
DatabaseName
The name for your database of up to 64 alphanumeric characters. If you
don't provide a name, Amazon RDS doesn't create a database in the DB
cluster you are creating.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
DBClusterIdentifier
[required] The identifier for this DB cluster. This parameter is stored as a
lowercase string.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
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
The name of the DB cluster parameter group to associate with this DB
cluster. If you don't specify a value, then the default DB cluster
parameter group for the specified DB engine and version is used.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
If supplied, must match the name of an existing DB cluster parameter
group.
VpcSecurityGroupIds
A list of EC2 VPC security groups to associate with this DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
DBSubnetGroupName
A DB subnet group to associate with this DB cluster.
This setting is required to create a Multi-AZ DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must match the name of an existing DB subnet group.
Must not be default.
Example: mydbsubnetgroup
Engine
[required] The database engine to use for this DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: aurora-mysql | aurora-postgresql | mysql | postgres
EngineVersion
The version number of the database engine to use.
To list all of the available engine versions for Aurora MySQL version 2
(5.7-compatible) and version 3 (MySQL 8.0-compatible), use the following
command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
You can supply either 5.7 or 8.0 to use the default engine version
for Aurora MySQL version 2 or version 3, respectively.
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"
For information about a specific engine, see the following topics:
Aurora MySQL - see Database engine updates for Amazon Aurora MySQL
in the Amazon Aurora User Guide.
Aurora PostgreSQL - see Amazon Aurora PostgreSQL releases and engine versions
in the Amazon Aurora User Guide.
RDS for MySQL - see Amazon RDS for MySQL
in the Amazon RDS User Guide.
RDS for PostgreSQL - see Amazon RDS for PostgreSQL
in the Amazon RDS User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Port
The port number on which the instances in the DB cluster accept
connections.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: 1150-65535
Default:
RDS for MySQL and Aurora MySQL - 3306
RDS for PostgreSQL and Aurora PostgreSQL - 5432
MasterUsername
The name of the master user for the DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
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
The password for the master database user.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 8 to 41 characters.
Can contain any printable ASCII character except "/", """, or "@".
Can't be specified if ManageMasterUserPassword is turned on.
OptionGroupName
The option group to associate the DB cluster with.
DB clusters are associated with a default option group that can't be
modified.
PreferredBackupWindow
The daily time range during which automated backups are created if
automated backups are enabled using the BackupRetentionPeriod
parameter.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
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
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
The weekly time range during which system maintenance can occur.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
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 DB Cluster Maintenance Window
in the Amazon Aurora User Guide.
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi.
Days must be one of Mon | Tue | Wed | Thu | Fri | Sat | Sun.
Must be in Universal Coordinated Time (UTC).
Must be at least 30 minutes.
ReplicationSourceIdentifier
The Amazon Resource Name (ARN) of the source DB instance or DB cluster
if this DB cluster is created as a read replica.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Tags
Tags to assign to the DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
StorageEncrypted
Specifies whether the DB cluster is encrypted.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
KmsKeyId
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 KMS key. To use a KMS key in a different
Amazon Web Services account, specify the key ARN or alias ARN.
When a KMS key isn't specified in KmsKeyId:
If ReplicationSourceIdentifier identifies an encrypted source,
then Amazon RDS uses the KMS key used to encrypt the source.
Otherwise, Amazon RDS uses your default KMS key.
If the StorageEncrypted parameter is enabled and
ReplicationSourceIdentifier isn't specified, then Amazon RDS uses
your default KMS key.
There is a default KMS key for your Amazon Web Services account. Your
Amazon Web Services account has a different default KMS key for each
Amazon Web Services Region.
If you create a read replica of an encrypted DB cluster in another
Amazon Web Services Region, make sure to set KmsKeyId to a KMS key
identifier that is valid in the destination Amazon Web Services Region.
This KMS key is used to encrypt the read replica in that Amazon Web
Services Region.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
PreSignedUrl
When you are replicating a DB cluster from one Amazon Web Services
GovCloud (US) Region to another, an URL that contains a Signature
Version 4 signed request for the
create_db_cluster operation to be called in
the source Amazon Web Services Region where the DB cluster is replicated
from. Specify PreSignedUrl only when you are performing cross-Region
replication from an encrypted DB cluster.
The presigned URL must be a valid request for the
create_db_cluster API operation that can run
in the source Amazon Web Services Region that contains the encrypted DB
cluster to copy.
The presigned URL request must contain the following parameter values:
-
KmsKeyId - The KMS key identifier for the KMS key to use to
encrypt the copy of the DB cluster in the destination Amazon Web
Services Region. This should refer to the same KMS key for both the
create_db_cluster operation that is
called in the destination Amazon Web Services Region, and the
operation contained in the presigned URL.
-
DestinationRegion - The name of the Amazon Web Services Region
that Aurora read replica will be created in.
-
ReplicationSourceIdentifier - The DB cluster identifier for the
encrypted DB cluster to be copied. This identifier must be in the
Amazon Resource Name (ARN) format for the source Amazon Web Services
Region. For example, if you are copying an encrypted DB cluster from
the us-west-2 Amazon Web Services Region, then your
ReplicationSourceIdentifier would look like Example:
arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.
To learn how to generate a Signature Version 4 signed request, see
Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4)
and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can
specify SourceRegion (or --source-region for the CLI) instead of
specifying PreSignedUrl manually. Specifying SourceRegion
autogenerates a presigned URL that is a valid request for the operation
that can run in the source Amazon Web Services Region.
Valid for Cluster Type: Aurora DB clusters only
If you supply a value for this operation's SourceRegion parameter, a
pre-signed URL will be calculated on your behalf.
EnableIAMDatabaseAuthentication
Specifies 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 Cluster Type: Aurora DB clusters only
BacktrackWindow
The target backtrack window, in seconds. To disable backtracking, set
this value to 0.
Valid for Cluster Type: Aurora MySQL DB clusters only
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200
(72 hours).
EnableCloudwatchLogsExports
The list of log types that need to be enabled for exporting to
CloudWatch Logs.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
The following values are valid for each DB engine:
Aurora MySQL - audit | error | general | slowquery
Aurora PostgreSQL - postgresql
RDS for MySQL - error | general | slowquery
RDS for PostgreSQL - postgresql | upgrade
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.
EngineMode
The DB engine mode of the DB cluster, either provisioned or
serverless.
The serverless engine mode only applies for Aurora Serverless v1 DB
clusters.
For information about limitations and requirements for Serverless DB
clusters, see the following sections in the Amazon Aurora User Guide:
Valid for Cluster Type: Aurora DB clusters only
ScalingConfiguration
For DB clusters in serverless DB engine mode, the scaling properties
of the DB cluster.
Valid for Cluster Type: Aurora DB clusters only
DeletionProtection
Specifies 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 Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
GlobalClusterIdentifier
The global cluster ID of an Aurora cluster that becomes the primary
cluster in the new global database cluster.
Valid for Cluster Type: Aurora DB clusters only
EnableHttpEndpoint
Specifies whether to enable the HTTP endpoint for an Aurora Serverless
v1 DB cluster. By default, the HTTP endpoint is disabled.
When enabled, the HTTP endpoint provides a connectionless web service
API for running SQL queries on the Aurora Serverless v1 DB cluster. You
can also query your database from inside the RDS console with the query
editor.
For more information, see Using the Data API for Aurora Serverless v1
in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
CopyTagsToSnapshot
Specifies whether to copy all tags from the DB cluster to snapshots of
the DB cluster. The default is not to copy them.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Domain
The Active Directory directory ID to create the DB cluster in.
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
in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
DomainIAMRoleName
The name of the IAM role to use when making API calls to the Directory
Service.
Valid for Cluster Type: Aurora DB clusters only
EnableGlobalWriteForwarding
Specifies whether to enable this DB cluster to forward write operations
to the primary cluster of a global cluster (Aurora global database). By
default, write operations are not allowed on Aurora DB clusters that are
secondary clusters in an Aurora global database.
You can set this value only on Aurora DB clusters that are members of an
Aurora global database. With this parameter enabled, a secondary cluster
can forward writes to the current primary cluster, and the resulting
changes are replicated back to this cluster. For the primary DB cluster
of an Aurora global database, this value is used immediately if the
primary is demoted by a global cluster API operation, but it does
nothing until then.
Valid for Cluster Type: Aurora DB clusters only
DBClusterInstanceClass
The compute and memory capacity of 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.
This setting is required to create a Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters only
AllocatedStorage
The amount of storage in gibibytes (GiB) to allocate to each DB instance
in the Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters only
This setting is required to create a Multi-AZ DB cluster.
StorageType
The storage type to associate with the DB cluster.
For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters.
For information on storage types for Multi-AZ DB clusters, see Settings for creating Multi-AZ DB clusters.
This setting is required to create a Multi-AZ DB cluster.
When specified for a Multi-AZ DB cluster, a value for the Iops
parameter is required.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values:
Aurora DB clusters - aurora | aurora-iopt1
Multi-AZ DB clusters - io1
Default:
Aurora DB clusters - aurora
Multi-AZ DB clusters - io1
When you create an Aurora DB cluster with the storage type set to
aurora-iopt1, the storage type is returned in the response. The
storage type isn't returned when you set it to aurora.
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 Provisioned IOPS storage
in the Amazon RDS User Guide.
This setting is required to create a Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters only
Constraints:
Must be a multiple between .5 and 50 of the storage amount for the
DB cluster.
PubliclyAccessible
Specifies 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 isn't
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.
Valid for Cluster Type: Multi-AZ DB clusters only
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.
AutoMinorVersionUpgrade
Specifies whether minor engine upgrades are applied automatically to the
DB cluster during the maintenance window. By default, minor engine
upgrades are applied automatically.
Valid for Cluster Type: Multi-AZ DB clusters only
MonitoringInterval
The interval, in seconds, between points when Enhanced Monitoring
metrics are collected for the DB cluster. To turn off collecting
Enhanced Monitoring metrics, specify 0.
If MonitoringRoleArn is specified, also set MonitoringInterval to a
value other than 0.
Valid for Cluster Type: Multi-AZ DB clusters only
Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default: 0
MonitoringRoleArn
The Amazon Resource Name (ARN) for the IAM role that permits RDS to send
Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is
arn:aws:iam:123456789012:role/emaccess. For information on creating a
monitoring role, see Setting up and enabling Enhanced Monitoring
in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, supply a
MonitoringRoleArn value.
Valid for Cluster Type: Multi-AZ DB clusters only
EnablePerformanceInsights
Specifies whether to turn on Performance Insights for the DB cluster.
For more information, see Using Amazon Performance Insights
in the Amazon RDS User Guide.
Valid for Cluster Type: Multi-AZ DB clusters only
PerformanceInsightsKMSKeyId
The Amazon Web Services KMS key identifier for encryption of Performance
Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias
ARN, or alias name for the KMS key.
If you don't specify a value for PerformanceInsightsKMSKeyId, then
Amazon RDS uses your default KMS key. There is a default KMS key for
your Amazon Web Services account. Your Amazon Web Services account has a
different default KMS key for each Amazon Web Services Region.
Valid for Cluster Type: Multi-AZ DB clusters only
PerformanceInsightsRetentionPeriod
The number of days to retain Performance Insights data.
Valid for Cluster Type: Multi-AZ DB clusters only
Valid Values:
-
7
-
month * 31, where month is a number of months from 1-23.
Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19
months * 31)
-
731
Default: 7 days
If you specify a retention period that isn't valid, such as 94, Amazon
RDS issues an error.
ServerlessV2ScalingConfiguration
NetworkType
The network type of the DB cluster.
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 Cluster Type: Aurora DB clusters only
Valid Values: IPV4 | DUAL
DBSystemId
Reserved for future use.
ManageMasterUserPassword
Specifies whether to manage the master user password with Amazon Web
Services Secrets Manager.
For more information, see Password management with Amazon Web Services Secrets Manager
in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager
in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Can't manage the master user password with Amazon Web Services
Secrets Manager if MasterUserPassword is specified.
MasterUserSecretKmsKeyId
The Amazon Web Services KMS key identifier to encrypt a secret that is
automatically generated and managed in Amazon Web Services Secrets
Manager.
This setting is valid only if the master user password is managed by RDS
in Amazon Web Services Secrets Manager for the DB cluster.
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.
If you don't specify MasterUserSecretKmsKeyId, then the
aws/secretsmanager KMS key is used to encrypt the secret. If the
secret is in a different Amazon Web Services account, then you can't use
the aws/secretsmanager KMS key to encrypt the secret, and you must use
a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your
Amazon Web Services account has a different default KMS key for each
Amazon Web Services Region.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
EnableLocalWriteForwarding
Specifies whether read replicas can forward write operations to the
writer DB instance in the DB cluster. By default, write operations
aren't allowed on reader DB instances.
Valid for: Aurora DB clusters only
SourceRegion
The ID of the region that contains the source for the read replica.
paws.database documentation built on Sept. 12, 2023, 1:21 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
View source: R/rds_operations.R
| rds_create_db_cluster | R Documentation |
Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster
Description
Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.
See https://www.paws-r-sdk.com/docs/rds_create_db_cluster/ for full documentation.
Usage
rds_create_db_cluster(
AvailabilityZones = NULL,
BackupRetentionPeriod = NULL,
CharacterSetName = NULL,
DatabaseName = NULL,
DBClusterIdentifier,
DBClusterParameterGroupName = NULL,
VpcSecurityGroupIds = NULL,
DBSubnetGroupName = NULL,
Engine,
EngineVersion = NULL,
Port = NULL,
MasterUsername = NULL,
MasterUserPassword = NULL,
OptionGroupName = NULL,
PreferredBackupWindow = NULL,
PreferredMaintenanceWindow = NULL,
ReplicationSourceIdentifier = NULL,
Tags = NULL,
StorageEncrypted = NULL,
KmsKeyId = NULL,
PreSignedUrl = NULL,
EnableIAMDatabaseAuthentication = NULL,
BacktrackWindow = NULL,
EnableCloudwatchLogsExports = NULL,
EngineMode = NULL,
ScalingConfiguration = NULL,
DeletionProtection = NULL,
GlobalClusterIdentifier = NULL,
EnableHttpEndpoint = NULL,
CopyTagsToSnapshot = NULL,
Domain = NULL,
DomainIAMRoleName = NULL,
EnableGlobalWriteForwarding = NULL,
DBClusterInstanceClass = NULL,
AllocatedStorage = NULL,
StorageType = NULL,
Iops = NULL,
PubliclyAccessible = NULL,
AutoMinorVersionUpgrade = NULL,
MonitoringInterval = NULL,
MonitoringRoleArn = NULL,
EnablePerformanceInsights = NULL,
PerformanceInsightsKMSKeyId = NULL,
PerformanceInsightsRetentionPeriod = NULL,
ServerlessV2ScalingConfiguration = NULL,
NetworkType = NULL,
DBSystemId = NULL,
ManageMasterUserPassword = NULL,
MasterUserSecretKmsKeyId = NULL,
EnableLocalWriteForwarding = NULL,
SourceRegion = NULL
)
Arguments
AvailabilityZones |
A list of Availability Zones (AZs) where DB instances in the DB cluster can be created. For information on Amazon Web Services Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only |
BackupRetentionPeriod |
The number of days for which automated backups are retained. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Default: Constraints:
|
CharacterSetName |
The name of the character set ( Valid for Cluster Type: Aurora DB clusters only |
DatabaseName |
The name for your database of up to 64 alphanumeric characters. If you don't provide a name, Amazon RDS doesn't create a database in the DB cluster you are creating. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters |
DBClusterIdentifier |
[required] The identifier for this DB cluster. This parameter is stored as a lowercase string. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Constraints:
Example: |
DBClusterParameterGroupName |
The name of the DB cluster parameter group to associate with this DB cluster. If you don't specify a value, then the default DB cluster parameter group for the specified DB engine and version is used. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Constraints:
|
VpcSecurityGroupIds |
A list of EC2 VPC security groups to associate with this DB cluster. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters |
DBSubnetGroupName |
A DB subnet group to associate with this DB cluster. This setting is required to create a Multi-AZ DB cluster. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Constraints:
Example: |
Engine |
[required] The database engine to use for this DB cluster. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values: |
EngineVersion |
The version number of the database engine to use. To list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (MySQL 8.0-compatible), use the following command:
You can supply either To list all of the available engine versions for Aurora PostgreSQL, use the following command:
To list all of the available engine versions for RDS for MySQL, use the following command:
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
For information about a specific engine, see the following topics:
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters |
Port |
The port number on which the instances in the DB cluster accept connections. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values: Default:
|
MasterUsername |
The name of the master user for the DB cluster. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Constraints:
|
MasterUserPassword |
The password for the master database user. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Constraints:
|
OptionGroupName |
The option group to associate the DB cluster with. DB clusters are associated with a default option group that can't be modified. |
PreferredBackupWindow |
The daily time range during which automated backups are created if
automated backups are enabled using the Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters 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 in the Amazon Aurora User Guide. Constraints:
|
PreferredMaintenanceWindow |
The weekly time range during which system maintenance can occur. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters 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 DB Cluster Maintenance Window in the Amazon Aurora User Guide. Constraints:
|
ReplicationSourceIdentifier |
The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters |
Tags |
Tags to assign to the DB cluster. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters |
StorageEncrypted |
Specifies whether the DB cluster is encrypted. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters |
KmsKeyId |
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 KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. When a KMS key isn't specified in
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. If you create a read replica of an encrypted DB cluster in another
Amazon Web Services Region, make sure to set Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters |
PreSignedUrl |
When you are replicating a DB cluster from one Amazon Web Services
GovCloud (US) Region to another, an URL that contains a Signature
Version 4 signed request for the
The presigned URL must be a valid request for the
The presigned URL request must contain the following parameter values:
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process. If you are using an Amazon Web Services SDK tool or the CLI, you can
specify Valid for Cluster Type: Aurora DB clusters only If you supply a value for this operation's |
EnableIAMDatabaseAuthentication |
Specifies 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 Cluster Type: Aurora DB clusters only |
BacktrackWindow |
The target backtrack window, in seconds. To disable backtracking, set
this value to Valid for Cluster Type: Aurora MySQL DB clusters only Default: Constraints:
|
EnableCloudwatchLogsExports |
The list of log types that need to be enabled for exporting to CloudWatch Logs. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters The following values are valid for each DB engine:
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. |
EngineMode |
The DB engine mode of the DB cluster, either The For information about limitations and requirements for Serverless DB clusters, see the following sections in the Amazon Aurora User Guide: Valid for Cluster Type: Aurora DB clusters only |
ScalingConfiguration |
For DB clusters in Valid for Cluster Type: Aurora DB clusters only |
DeletionProtection |
Specifies 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 Cluster Type: Aurora DB clusters and Multi-AZ DB clusters |
GlobalClusterIdentifier |
The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster. Valid for Cluster Type: Aurora DB clusters only |
EnableHttpEndpoint |
Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint is disabled. When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor. For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only |
CopyTagsToSnapshot |
Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters |
Domain |
The Active Directory directory ID to create the DB cluster in. 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 in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only |
DomainIAMRoleName |
The name of the IAM role to use when making API calls to the Directory Service. Valid for Cluster Type: Aurora DB clusters only |
EnableGlobalWriteForwarding |
Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database. You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by a global cluster API operation, but it does nothing until then. Valid for Cluster Type: Aurora DB clusters only |
DBClusterInstanceClass |
The compute and memory capacity of each DB instance in the Multi-AZ DB
cluster, for example For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide. This setting is required to create a Multi-AZ DB cluster. Valid for Cluster Type: Multi-AZ DB clusters only |
AllocatedStorage |
The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster. Valid for Cluster Type: Multi-AZ DB clusters only This setting is required to create a Multi-AZ DB cluster. |
StorageType |
The storage type to associate with the DB cluster. For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters. For information on storage types for Multi-AZ DB clusters, see Settings for creating Multi-AZ DB clusters. This setting is required to create a Multi-AZ DB cluster. When specified for a Multi-AZ DB cluster, a value for the Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values:
Default:
When you create an Aurora DB cluster with the storage type set to
|
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 Provisioned IOPS storage in the Amazon RDS User Guide. This setting is required to create a Multi-AZ DB cluster. Valid for Cluster Type: Multi-AZ DB clusters only Constraints:
|
PubliclyAccessible |
Specifies 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 isn't 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. Valid for Cluster Type: Multi-AZ DB clusters only Default: The default behavior varies depending on whether
If
If
|
AutoMinorVersionUpgrade |
Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically. Valid for Cluster Type: Multi-AZ DB clusters only |
MonitoringInterval |
The interval, in seconds, between points when Enhanced Monitoring
metrics are collected for the DB cluster. To turn off collecting
Enhanced Monitoring metrics, specify If Valid for Cluster Type: Multi-AZ DB clusters only Valid Values: Default: |
MonitoringRoleArn |
The Amazon Resource Name (ARN) for the IAM role that permits RDS to send
Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is
If Valid for Cluster Type: Multi-AZ DB clusters only |
EnablePerformanceInsights |
Specifies whether to turn on Performance Insights for the DB cluster. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide. Valid for Cluster Type: Multi-AZ DB clusters only |
PerformanceInsightsKMSKeyId |
The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you don't specify a value for Valid for Cluster Type: Multi-AZ DB clusters only |
PerformanceInsightsRetentionPeriod |
The number of days to retain Performance Insights data. Valid for Cluster Type: Multi-AZ DB clusters only Valid Values:
Default: If you specify a retention period that isn't valid, such as |
ServerlessV2ScalingConfiguration |
|
NetworkType |
The network type of the DB cluster. The network type is determined by the For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only Valid Values: |
DBSystemId |
Reserved for future use. |
ManageMasterUserPassword |
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager. For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Constraints:
|
MasterUserSecretKmsKeyId |
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager. This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster. 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. If you don't specify There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters |
EnableLocalWriteForwarding |
Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances. Valid for: Aurora DB clusters only |
SourceRegion |
The ID of the region that contains the source for the read replica. |
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.