create_db_cluster
async
¶
create_db_cluster(
*,
config_overrides: Optional[AsyncRDSClientConfig] = None,
availability_zones: Optional[AvailabilityZones] = None,
backup_retention_period: Optional[IntegerOptional] = None,
character_set_name: Optional[String] = None,
database_name: Optional[String] = None,
db_cluster_identifier: Optional[String] = None,
db_cluster_parameter_group_name: Optional[String] = None,
vpc_security_group_ids: Optional[VpcSecurityGroupIdList] = None,
db_subnet_group_name: Optional[String] = None,
engine: Optional[String] = None,
engine_version: Optional[String] = None,
port: Optional[IntegerOptional] = None,
master_username: Optional[String] = None,
master_user_password: Optional[SensitiveString] = None,
option_group_name: Optional[String] = None,
preferred_backup_window: Optional[String] = None,
preferred_maintenance_window: Optional[String] = None,
replication_source_identifier: Optional[String] = None,
tags: Optional[TagList] = None,
storage_encrypted: Optional[BooleanOptional] = None,
kms_key_id: Optional[String] = None,
pre_signed_url: Optional[SensitiveString] = None,
enable_iam_database_authentication: Optional[BooleanOptional] = None,
backtrack_window: Optional[LongOptional] = None,
enable_cloudwatch_logs_exports: Optional[LogTypeList] = None,
engine_mode: Optional[String] = None,
scaling_configuration: Optional[ScalingConfiguration] = None,
rds_custom_cluster_configuration: Optional[RdsCustomClusterConfiguration] = None,
db_cluster_instance_class: Optional[String] = None,
allocated_storage: Optional[IntegerOptional] = None,
storage_type: Optional[String] = None,
iops: Optional[IntegerOptional] = None,
publicly_accessible: Optional[BooleanOptional] = None,
auto_minor_version_upgrade: Optional[BooleanOptional] = None,
deletion_protection: Optional[BooleanOptional] = None,
global_cluster_identifier: Optional[GlobalClusterIdentifier] = None,
enable_http_endpoint: Optional[BooleanOptional] = None,
copy_tags_to_snapshot: Optional[BooleanOptional] = None,
domain: Optional[String] = None,
domain_iam_role_name: Optional[String] = None,
enable_global_write_forwarding: Optional[BooleanOptional] = None,
network_type: Optional[String] = None,
serverless_v2_scaling_configuration: Optional[
ServerlessV2ScalingConfiguration
] = None,
monitoring_interval: Optional[IntegerOptional] = None,
monitoring_role_arn: Optional[String] = None,
database_insights_mode: Optional[DatabaseInsightsMode] = None,
enable_performance_insights: Optional[BooleanOptional] = None,
performance_insights_kms_key_id: Optional[String] = None,
performance_insights_retention_period: Optional[IntegerOptional] = None,
enable_limitless_database: Optional[BooleanOptional] = None,
cluster_scalability_type: Optional[ClusterScalabilityType] = None,
db_system_id: Optional[String] = None,
manage_master_user_password: Optional[BooleanOptional] = None,
enable_local_write_forwarding: Optional[BooleanOptional] = None,
master_user_secret_kms_key_id: Optional[String] = None,
ca_certificate_identifier: Optional[String] = None,
engine_lifecycle_support: Optional[String] = None,
tag_specifications: Optional[TagSpecificationList] = None,
master_user_authentication_type: Optional[MasterUserAuthenticationType] = None,
with_express_configuration: Optional[BooleanOptional] = None,
associated_roles: Optional[DBClusterAssociatedRoles] = None,
) -> CreateDBClusterResult
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.
You can use the WithExpressConfiguration parameter to create an Aurora DB Cluster with express configuration and create cluster in seconds. Express configuration provides a cluster with a writer instance and feature specific values set to all other input parameters of this API.
You can use the AssociatedRoles parameter to associate one or more Amazon Web Services Identity and Access Management (IAM) roles with an Aurora DB cluster. Each associated role lets the DB cluster access other Amazon Web Services on your behalf, such as Amazon S3 for data import and export, or Amazon Web Services Lambda for invoking functions.
Parameters:
-
availability_zones(Optional[AvailabilityZones], default:None) –A list of Availability Zones (AZs) where you specifically want to create DB instances in the DB cluster.
For the first three DB instances that you create, RDS distributes each DB instance to a different AZ that you specify. For additional DB instances that you create, RDS randomly distributes them to the AZs that you specified. For example, if you create a DB cluster with one writer instance and three reader instances, RDS might distribute the writer instance to AZ 1, the first reader instance to AZ 2, the second reader instance to AZ 3, and the third reader instance to either AZ 1, AZ 2, or AZ 3.
For more information, see Availability Zones and High availability for Aurora DB instances in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
Constraints:
-
Can't specify more than three AZs.
-
-
backup_retention_period(Optional[IntegerOptional], default:None) –The number of days for which automated backups are retained.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Default:
1Constraints:
-
Must be a value from 1 to 35.
-
-
character_set_name(Optional[String], default:None) –The name of the character set (
CharacterSet) to associate the DB cluster with.Valid for Cluster Type: Aurora DB clusters only
-
database_name(Optional[String], default:None) –The name for your database of up to 64 alphanumeric characters. A database named
postgresis always created. If this parameter is specified, an additional database with this name is created.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
-
db_cluster_identifier(Optional[String], default:None) –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 (for Aurora DB clusters) or 1 to 52 (for Multi-AZ DB clusters) letters, numbers, or hyphens.
-
First character must be a letter.
-
Can't end with a hyphen or contain two consecutive hyphens.
Example:
my-cluster1 -
-
db_cluster_parameter_group_name(Optional[String], default:None) –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.
-
-
vpc_security_group_ids(Optional[VpcSecurityGroupIdList], default:None) –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
-
db_subnet_group_name(Optional[String], default:None) –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.
Example:
mydbsubnetgroup -
-
engine(Optional[String], default:None) –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 -
neptune- For information about using Amazon Neptune, see the Amazon Neptune User Guide .
-
-
engine_version(Optional[String], default:None) –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.7or8.0to 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(Optional[IntegerOptional], default:None) –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-65535Default:
-
RDS for MySQL and Aurora MySQL -
3306 -
RDS for PostgreSQL and Aurora PostgreSQL -
5432
-
-
master_username(Optional[String], default:None) –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.
-
-
master_user_password(Optional[SensitiveString], default:None) –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
ManageMasterUserPasswordis turned on.
-
-
option_group_name(Optional[String], default:None) –The option group to associate the DB cluster with.
DB clusters are associated with a default option group that can't be modified.
-
preferred_backup_window(Optional[String], default:None) –The daily time range during which automated backups are created if automated backups are enabled using the
BackupRetentionPeriodparameter.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.
-
-
preferred_maintenance_window(Optional[String], default:None) –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.
-
-
replication_source_identifier(Optional[String], default:None) –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(Optional[TagList], default:None) –Tags to assign to the DB cluster.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
-
storage_encrypted(Optional[BooleanOptional], default:None) –Specifies whether the DB cluster is encrypted.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
-
kms_key_id(Optional[String], default:None) –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
ReplicationSourceIdentifieridentifies 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
StorageEncryptedparameter is enabled andReplicationSourceIdentifierisn'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
KmsKeyIdto 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
-
-
pre_signed_url(Optional[SensitiveString], default:None) –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
CreateDBClusteroperation to be called in the source Amazon Web Services Region where the DB cluster is replicated from. SpecifyPreSignedUrlonly when you are performing cross-Region replication from an encrypted DB cluster.The presigned URL must be a valid request for the
CreateDBClusterAPI 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 theCreateDBClusteroperation 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 yourReplicationSourceIdentifierwould 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-regionfor the CLI) instead of specifyingPreSignedUrlmanually. SpecifyingSourceRegionautogenerates 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
-
-
enable_iam_database_authentication(Optional[BooleanOptional], default:None) –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 or IAM database authentication for MariaDB, MySQL, and PostgreSQL in the Amazon RDS User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
-
backtrack_window(Optional[LongOptional], default:None) –The target backtrack window, in seconds. To disable backtracking, set this value to
0.Valid for Cluster Type: Aurora MySQL DB clusters only
Default:
0Constraints:
-
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
-
-
enable_cloudwatch_logs_exports(Optional[LogTypeList], default:None) –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 | instance | slowquery | iam-db-auth-error -
Aurora PostgreSQL -
instance | postgresql | iam-db-auth-error -
RDS for MySQL -
error | general | slowquery | iam-db-auth-error -
RDS for PostgreSQL -
postgresql | upgrade | iam-db-auth-error
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.
-
-
engine_mode(Optional[String], default:None) –The DB engine mode of the DB cluster, either
provisionedorserverless.The
serverlessengine mode only applies for Aurora Serverless v1 DB clusters. Aurora Serverless v2 DB clusters use theprovisionedengine mode.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
-
scaling_configuration(Optional[ScalingConfiguration], default:None) –For DB clusters in
serverlessDB engine mode, the scaling properties of the DB cluster.Valid for Cluster Type: Aurora DB clusters only
-
rds_custom_cluster_configuration(Optional[RdsCustomClusterConfiguration], default:None) –Reserved for future use.
-
db_cluster_instance_class(Optional[String], default:None) –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
-
allocated_storage(Optional[IntegerOptional], default:None) –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.
-
storage_type(Optional[String], default:None) –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
Iopsparameter 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 | io2 | gp3
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 toaurora. -
-
iops(Optional[IntegerOptional], default:None) –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.
-
-
publicly_accessible(Optional[BooleanOptional], default:None) –Specifies whether the DB cluster is publicly accessible.
Valid for Cluster Type: Multi-AZ DB clusters only
When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its domain name system (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is controlled by its security group settings.
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.
The default behavior when
PubliclyAccessibleis not specified depends on whether aDBSubnetGroupis specified.If
DBSubnetGroupisn't specified,PubliclyAccessibledefaults totrue.If
DBSubnetGroupis specified,PubliclyAccessibledefaults tofalseunless the value ofDBSubnetGroupisdefault, in which casePubliclyAccessibledefaults totrue.If
PubliclyAccessibleis true and the VPC that theDBSubnetGroupis in doesn't have an internet gateway attached to it, Amazon RDS returns an error. -
auto_minor_version_upgrade(Optional[BooleanOptional], default:None) –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: Aurora DB clusters and Multi-AZ DB cluster.
For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.
-
deletion_protection(Optional[BooleanOptional], default:None) –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
-
global_cluster_identifier(Optional[GlobalClusterIdentifier], default:None) –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
-
enable_http_endpoint(Optional[BooleanOptional], default:None) –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.
For more information, see Using RDS Data API in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
-
copy_tags_to_snapshot(Optional[BooleanOptional], default:None) –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(Optional[String], default:None) –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
-
domain_iam_role_name(Optional[String], default:None) –The name of the IAM role to use when making API calls to the Directory Service.
Valid for Cluster Type: Aurora DB clusters only
-
enable_global_write_forwarding(Optional[BooleanOptional], default:None) –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
-
network_type(Optional[String], default:None) –The network type of the DB cluster.
The network type is determined by the
DBSubnetGroupspecified for the DB cluster. ADBSubnetGroupcan 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 -
monitoring_interval(Optional[IntegerOptional], default:None) –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
MonitoringRoleArnis specified, also setMonitoringIntervalto a value other than0.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values:
0 | 1 | 5 | 10 | 15 | 30 | 60Default:
0 -
monitoring_role_arn(Optional[String], default:None) –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
MonitoringIntervalis set to a value other than0, supply aMonitoringRoleArnvalue.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
-
database_insights_mode(Optional[DatabaseInsightsMode], default:None) –The mode of Database Insights to enable for the DB cluster.
If you set this value to
advanced, you must also set thePerformanceInsightsEnabledparameter totrueand thePerformanceInsightsRetentionPeriodparameter to 465.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
-
enable_performance_insights(Optional[BooleanOptional], default:None) –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: Aurora DB clusters and Multi-AZ DB clusters
-
performance_insights_kms_key_id(Optional[String], default:None) –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: Aurora DB clusters and Multi-AZ DB clusters
-
performance_insights_retention_period(Optional[IntegerOptional], default:None) –The number of days to retain Performance Insights data.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
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:
7daysIf you specify a retention period that isn't valid, such as
94, Amazon RDS issues an error. -
-
enable_limitless_database(Optional[BooleanOptional], default:None) –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
This setting is no longer used. Instead use the
ClusterScalabilityTypesetting. -
cluster_scalability_type(Optional[ClusterScalabilityType], default:None) –Specifies the scalability mode of the Aurora DB cluster. When set to
limitless, the cluster operates as an Aurora Limitless Database. When set tostandard(the default), the cluster uses normal DB instance creation.Valid for: Aurora DB clusters only
You can't modify this setting after you create the DB cluster.
-
db_system_id(Optional[String], default:None) –Reserved for future use.
-
manage_master_user_password(Optional[BooleanOptional], default:None) –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
MasterUserPasswordis specified.
-
-
enable_local_write_forwarding(Optional[BooleanOptional], default:None) –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
-
master_user_secret_kms_key_id(Optional[String], default:None) –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 theaws/secretsmanagerKMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use theaws/secretsmanagerKMS 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
-
ca_certificate_identifier(Optional[String], default:None) –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
-
engine_lifecycle_support(Optional[String], default:None) –The lifecycle type for this DB cluster.
By default, this value is set to
open-source-rds-extended-support, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value toopen-source-rds-extended-support-disabled. In this case, creating the DB cluster will fail if the DB major version is past its end of standard support date.You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
-
Amazon Aurora - Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide
-
Amazon RDS - Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values:
open-source-rds-extended-support | open-source-rds-extended-support-disabledDefault:
open-source-rds-extended-support -
-
tag_specifications(Optional[TagSpecificationList], default:None) –Tags to assign to resources associated with the DB cluster.
Valid Values:
-
cluster-auto-backup- The DB cluster's automated backup.
-
-
master_user_authentication_type(Optional[MasterUserAuthenticationType], default:None) –Specifies the authentication type for the master user. With IAM master user authentication, you can configure the master DB user with IAM database authentication when you create a DB cluster.
You can specify one of the following values:
-
password- Use standard database authentication with a password. -
iam-db-auth- Use IAM database authentication for the master user.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
This option is only valid for RDS for PostgreSQL and Aurora PostgreSQL engines.
-
-
with_express_configuration(Optional[BooleanOptional], default:None) –Specifies to create an Aurora DB Cluster with express configuration in seconds. Express configuration provides a cluster with a writer instance and feature specific values set to all other input parameters of this API.
Valid for Cluster Type: Aurora DB clusters
-
associated_roles(Optional[DBClusterAssociatedRoles], default:None) –A list of Amazon Web Services Identity and Access Management (IAM) roles to associate with the DB cluster. Each role grants the DB cluster permission to access other Amazon Web Services on your behalf. For each role, specify a role ARN and, optionally, the feature name (such as
s3Import,s3Export, orLambda).Valid for Cluster Type: Aurora DB clusters only
Raises:
-
DBClusterAlreadyExistsFault–The user already has a DB cluster with the given identifier.
-
DBClusterNotFoundFault–DBClusterIdentifierdoesn't refer to an existing DB cluster. -
DBClusterParameterGroupNotFoundFault–DBClusterParameterGroupNamedoesn't refer to an existing DB cluster parameter group. -
DBClusterQuotaExceededFault–The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
-
DBClusterRoleQuotaExceededFault–You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.
-
DBInstanceNotFoundFault–DBInstanceIdentifierdoesn't refer to an existing DB instance. -
DBSubnetGroupDoesNotCoverEnoughAZs–Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
-
DBSubnetGroupNotFoundFault–DBSubnetGroupNamedoesn't refer to an existing DB subnet group. -
DomainNotFoundFault–Domaindoesn't refer to an existing Active Directory domain. -
GlobalClusterNotFoundFault–The
GlobalClusterIdentifierdoesn't refer to an existing global database cluster. -
InsufficientDBInstanceCapacityFault–The specified DB instance class isn't available in the specified Availability Zone.
-
InsufficientStorageClusterCapacityFault–There is insufficient storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.
-
InvalidDBClusterStateFault–The requested operation can't be performed while the cluster is in this state.
-
InvalidDBInstanceStateFault–The DB instance isn't in a valid state.
-
InvalidDBSubnetGroupFault–The DBSubnetGroup doesn't belong to the same VPC as that of an existing cross-region read replica of the same source instance.
-
InvalidDBSubnetGroupStateFault–The DB subnet group cannot be deleted because it's in use.
-
InvalidGlobalClusterStateFault–The global cluster is in an invalid state and can't perform the requested operation.
-
InvalidSubnet–The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
-
InvalidVPCNetworkStateFault–The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.
-
KMSKeyNotAccessibleFault–An error occurred accessing an Amazon Web Services KMS key.
-
NetworkTypeNotSupported–The network type is invalid for the DB instance. Valid nework type values are
IPV4andDUAL. -
OptionGroupNotFoundFault–The specified option group could not be found.
-
StorageQuotaExceededFault–The request would result in the user exceeding the allowed amount of storage available across all DB instances.
-
StorageTypeNotSupportedFault–The specified
StorageTypecan't be associated with the DB instance. -
VpcEncryptionControlViolationException–The operation violates VPC encryption control settings. Make sure that your DB instance type supports the Nitro encryption-in-transit capability, or modify your VPC's encryption controls to not enforce encryption-in-transit.
-
UnknownServiceError–The service returned an error code this client does not model.
Examples:
To create a MySQL 5.7-compatible DB cluster The following example creates a MySQL 5.7-compatible Aurora DB cluster.
>>> await client.create_db_cluster(db_cluster_identifier='sample-cluster', engine='aurora-mysql', engine_version='5.7.12', master_username='admin', master_user_password='mypassword', db_subnet_group_name='default', vpc_security_group_ids=['sg-0b91305example'])
To create a PostgreSQL-compatible DB cluster
The following example creates a PostgreSQL-compatible Aurora DB cluster.
>>> await client.create_db_cluster(db_cluster_identifier='sample-pg-cluster', engine='aurora-postgresql', master_username='admin', master_user_password='mypassword', vpc_security_group_ids=['sg-0b91305example'], db_subnet_group_name='default')
To create a Aurora DB cluster with express configuration
The following example creates a Aurora DB cluster with express configuration.
>>> await client.create_db_cluster(db_cluster_identifier='sample-cluster', engine='aurora-postgresql', with_express_configuration=True)
To create an Aurora DB cluster with an associated IAM role for Amazon S3 import
The following example creates an Aurora PostgreSQL-compatible DB cluster and associates an IAM role for Amazon S3 import in a single call.
>>> await client.create_db_cluster(db_cluster_identifier='sample-cluster', engine='aurora-postgresql', master_username='admin', master_user_password='mypassword', associated_roles=[{'RoleArn': 'arn:aws:iam::123456789012:role/RDSLoadFromS3', 'FeatureName': 's3Import'}])
Source code in docs_src/capo_rds/_services/async_rds.py
1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 | |