AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Container for the parameters to the CreateDBCluster operation. Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.
If you create an Aurora DB cluster, the request creates an empty cluster. You must explicitly create the writer instance for your DB cluster using the CreateDBInstance operation. If you create a Multi-AZ DB cluster, the request creates a writer and two reader DB instances for you, each in a different Availability Zone.
You can use the ReplicationSourceIdentifier
parameter to create an Amazon Aurora
DB cluster as a read replica of another DB cluster or Amazon RDS for MySQL or PostgreSQL
DB instance. For more information about Amazon Aurora, see What
is Amazon Aurora? in the Amazon Aurora User Guide.
You can also use the ReplicationSourceIdentifier
parameter to create a Multi-AZ
DB cluster read replica with an RDS for MySQL or PostgreSQL DB instance as the source.
For more information about Multi-AZ DB clusters, see Multi-AZ
DB cluster deployments in the Amazon RDS User Guide.
Namespace: Amazon.RDS.Model
Assembly: AWSSDK.RDS.dll
Version: 3.x.y.z
public class CreateDBClusterRequest : AmazonRDSRequest IAmazonWebServiceRequest, IPreSignedUrlRequest
The CreateDBClusterRequest type exposes the following members
Name | Description | |
---|---|---|
CreateDBClusterRequest() |
Name | Type | Description | |
---|---|---|---|
AllocatedStorage | System.Int32 |
Gets and sets the property 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. |
|
AutoMinorVersionUpgrade | System.Boolean |
Gets and sets the property 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 |
|
AvailabilityZones | System.Collections.Generic.List<System.String> |
Gets and sets the property 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 |
|
BacktrackWindow | System.Int64 |
Gets and sets the property 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:
|
|
BackupRetentionPeriod | System.Int32 |
Gets and sets the property 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:
|
|
CACertificateIdentifier | System.String |
Gets and sets the property CACertificateIdentifier. The CA certificate identifier to use for the DB cluster's server certificate. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide. Valid for Cluster Type: Multi-AZ DB clusters |
|
CharacterSetName | System.String |
Gets and sets the property CharacterSetName.
The name of the character set ( Valid for Cluster Type: Aurora DB clusters only |
|
CopyTagsToSnapshot | System.Boolean |
Gets and sets the property 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 |
|
DatabaseName | System.String |
Gets and sets the property 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 | System.String |
Gets and sets the property DBClusterIdentifier. 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: |
|
DBClusterInstanceClass | System.String |
Gets and sets the property 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 |
|
DBClusterParameterGroupName | System.String |
Gets and sets the property 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:
|
|
DBSubnetGroupName | System.String |
Gets and sets the property 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: |
|
DBSystemId | System.String |
Gets and sets the property DBSystemId. Reserved for future use. |
|
DeletionProtection | System.Boolean |
Gets and sets the property 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 |
|
Domain | System.String |
Gets and sets the property 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 | System.String |
Gets and sets the property 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 |
|
EnableCloudwatchLogsExports | System.Collections.Generic.List<System.String> |
Gets and sets the property 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. |
|
EnableGlobalWriteForwarding | System.Boolean |
Gets and sets the property 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 |
|
EnableHttpEndpoint | System.Boolean |
Gets and sets the property EnableHttpEndpoint. Specifies whether to enable the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled. When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor. RDS Data API is supported with the following DB clusters:
For more information, see Using RDS Data API in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only |
|
EnableIAMDatabaseAuthentication | System.Boolean |
Gets and sets the property 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 |
|
EnableLimitlessDatabase | System.Boolean |
Gets and sets the property EnableLimitlessDatabase. Specifies whether to enable Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group. Valid for: Aurora DB clusters only |
|
EnableLocalWriteForwarding | System.Boolean |
Gets and sets the property 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 |
|
EnablePerformanceInsights | System.Boolean |
Gets and sets the property 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 |
|
Engine | System.String |
Gets and sets the property Engine. The database engine to use for this DB cluster. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values: |
|
EngineMode | System.String |
Gets and sets the property 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 |
|
EngineVersion | System.String |
Gets and sets the property 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 |
|
GlobalClusterIdentifier | System.String |
Gets and sets the property 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 |
|
Iops | System.Int32 |
Gets and sets the property 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:
|
|
KmsKeyId | System.String |
Gets and sets the property 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 |
|
ManageMasterUserPassword | System.Boolean |
Gets and sets the property 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:
|
|
MasterUsername | System.String |
Gets and sets the property 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 | System.String |
Gets and sets the property MasterUserPassword. The password for the master database user. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Constraints:
|
|
MasterUserSecretKmsKeyId | System.String |
Gets and sets the property 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 |
|
MonitoringInterval | System.Int32 |
Gets and sets the property 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 | System.String |
Gets and sets the property 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 |
|
NetworkType | System.String |
Gets and sets the property 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: |
|
OptionGroupName | System.String |
Gets and sets the property OptionGroupName. The option group to associate the DB cluster with. DB clusters are associated with a default option group that can't be modified. |
|
PerformanceInsightsKMSKeyId | System.String |
Gets and sets the property 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 | System.Int32 |
Gets and sets the property 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 |
|
Port | System.Int32 |
Gets and sets the property 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:
|
|
PreferredBackupWindow | System.String |
Gets and sets the property 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 | System.String |
Gets and sets the property 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:
|
|
PreSignedUrl | System.String |
Gets and sets the property 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 |
|
PubliclyAccessible | System.Boolean |
Gets and sets the property 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
|
|
RdsCustomClusterConfiguration | Amazon.RDS.Model.RdsCustomClusterConfiguration |
Gets and sets the property RdsCustomClusterConfiguration. Reserved for future use. |
|
ReplicationSourceIdentifier | System.String |
Gets and sets the property 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 |
|
ScalingConfiguration | Amazon.RDS.Model.ScalingConfiguration |
Gets and sets the property ScalingConfiguration.
For DB clusters in Valid for Cluster Type: Aurora DB clusters only |
|
ServerlessV2ScalingConfiguration | Amazon.RDS.Model.ServerlessV2ScalingConfiguration |
Gets and sets the property ServerlessV2ScalingConfiguration. |
|
SourceRegion | System.String |
The SourceRegion for generating the PreSignedUrl property. If SourceRegion is set and the PreSignedUrl property is not, then PreSignedUrl will be automatically generated by the client. |
|
StorageEncrypted | System.Boolean |
Gets and sets the property StorageEncrypted. Specifies whether the DB cluster is encrypted. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters |
|
StorageType | System.String |
Gets and sets the property 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 |
|
Tags | System.Collections.Generic.List<Amazon.RDS.Model.Tag> |
Gets and sets the property Tags. Tags to assign to the DB cluster. Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters |
|
VpcSecurityGroupIds | System.Collections.Generic.List<System.String> |
Gets and sets the property 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 |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5