AWS Native v0.112.0, Jul 24 24

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.rds.getDbCluster

Explore with Pulumi AI

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi

pulumi/pulumi-aws-native

The AWS::RDS::DBCluster resource creates an Amazon Aurora DB cluster or Multi-AZ DB cluster. For more information about creating an Aurora DB cluster, see Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide. For more information about creating a Multi-AZ DB cluster, see Creating a Multi-AZ DB cluster in the Amazon RDS User Guide. You can only create this resource in AWS Regions where Amazon Aurora or Multi-AZ DB clusters are supported. Updating DB clusters When properties labeled “Update requires: Replacement” are updated, AWS CloudFormation first creates a replacement DB cluster, then changes references from other dependent resources to point to the replacement DB cluster, and finally deletes the old DB cluster. We highly recommend that you take a snapshot of the database before updating the stack. If you don’t, you lose the data when AWS CloudFormation replaces your DB cluster. To preserve your data, perform the following procedure:

Deactivate any applications that are using the DB cluster so that there’s no activity on the DB instance.
Create a snapshot of the DB cluster. For more information, see Creating a DB Cluster Snapshot.
If you want to restore your DB cluster using a DB cluster snapshot, modify the updated template with your DB cluster changes and add the SnapshotIdentifier property with the ID of the DB cluster snapshot that you want to use. After you restore a DB cluster with a SnapshotIdentifier property, you must specify the same SnapshotIdentifier property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the DB cluster snapshot again, and the data in the database is not changed. However, if you don’t specify the SnapshotIdentifier property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB cluster is restored from the specified SnapshotIdentifier property, and the original DB cluster is deleted.
Update the stack.

Currently, when you are updating the stack for an Aurora Serverless DB cluster, you can’t include changes to any other properties when you specify one of the following properties: PreferredBackupWindow, PreferredMaintenanceWindow, and Port. This limitation doesn’t apply to provisioned DB clusters. For more information about updating other properties of this resource, see ModifyDBCluster. For more information about updating stacks, see CloudFormation Stacks Updates. Deleting DB clusters The default DeletionPolicy for AWS::RDS::DBCluster resources is Snapshot. For more information about how AWS CloudFormation deletes resources, see DeletionPolicy Attribute.

Using getDbCluster

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDbCluster(args: GetDbClusterArgs, opts?: InvokeOptions): Promise<GetDbClusterResult>
function getDbClusterOutput(args: GetDbClusterOutputArgs, opts?: InvokeOptions): Output<GetDbClusterResult>

def get_db_cluster(db_cluster_identifier: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetDbClusterResult
def get_db_cluster_output(db_cluster_identifier: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetDbClusterResult]

func LookupDbCluster(ctx *Context, args *LookupDbClusterArgs, opts ...InvokeOption) (*LookupDbClusterResult, error)
func LookupDbClusterOutput(ctx *Context, args *LookupDbClusterOutputArgs, opts ...InvokeOption) LookupDbClusterResultOutput

> Note: This function is named LookupDbCluster in the Go SDK.

public static class GetDbCluster 
{
    public static Task<GetDbClusterResult> InvokeAsync(GetDbClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetDbClusterResult> Invoke(GetDbClusterInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDbClusterResult> getDbCluster(GetDbClusterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws-native:rds:getDbCluster
  arguments:
    # arguments dictionary

The following arguments are supported:

DbClusterIdentifier string

The DB cluster identifier. This parameter is stored as a lowercase string. 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 Valid for: Aurora DB clusters and Multi-AZ DB clusters

DbClusterIdentifier string

The DB cluster identifier. This parameter is stored as a lowercase string. 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 Valid for: Aurora DB clusters and Multi-AZ DB clusters

dbClusterIdentifier String

The DB cluster identifier. This parameter is stored as a lowercase string. 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 Valid for: Aurora DB clusters and Multi-AZ DB clusters

dbClusterIdentifier string

The DB cluster identifier. This parameter is stored as a lowercase string. 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 Valid for: Aurora DB clusters and Multi-AZ DB clusters

db_cluster_identifier str

The DB cluster identifier. This parameter is stored as a lowercase string. 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 Valid for: Aurora DB clusters and Multi-AZ DB clusters

dbClusterIdentifier String

The DB cluster identifier. This parameter is stored as a lowercase string. 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 Valid for: Aurora DB clusters and Multi-AZ DB clusters

getDbCluster Result

The following output properties are available:

AllocatedStorage int

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.

AssociatedRoles List<Pulumi.AwsNative.Rds.Outputs.DbClusterDbClusterRole>

Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf. Valid for: Aurora DB clusters and Multi-AZ DB clusters

AutoMinorVersionUpgrade bool

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

BacktrackWindow int

The target backtrack window, in seconds. To disable backtracking, set this value to 0. Currently, Backtrack is only supported for Aurora MySQL DB clusters. Default: 0 Constraints:

If specified, this value must be set to a number from 0 to 259,200 (72 hours).

Valid for: Aurora MySQL DB clusters only

BackupRetentionPeriod int

The number of days for which automated backups are retained. Default: 1 Constraints:

Must be a value from 1 to 35

Valid for: Aurora DB clusters and Multi-AZ DB clusters

CopyTagsToSnapshot bool

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them. Valid for: Aurora DB clusters and Multi-AZ DB clusters

DbClusterArn string

The Amazon Resource Name (ARN) for the DB cluster.

DbClusterInstanceClass string

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 AWS-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

DbClusterParameterGroupName string

The name of the DB cluster parameter group to associate with this DB cluster. If you apply a parameter group to an existing DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting. If you apply a change to parameter group associated with a stopped DB cluster, then the update stack waits until the DB cluster is started. To list all of the available DB cluster parameter group names, use the following command:

aws rds describe-db-cluster-parameter-groups --query "DBClusterParameterGroups[].DBClusterParameterGroupName" --output text

Valid for: Aurora DB clusters and Multi-AZ DB clusters

DbClusterResourceId string

The AWS Region -unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB cluster is accessed.

DeletionProtection bool

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. Valid for: Aurora DB clusters and Multi-AZ DB clusters

Domain string

Indicates the directory ID of the Active Directory to create the DB cluster. 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: Aurora DB clusters only

DomainIamRoleName string

Specifies the name of the IAM role to use when making API calls to the Directory Service. Valid for: Aurora DB clusters only

EnableCloudwatchLogsExports List<string>

The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide. Aurora MySQL Valid values: audit, error, general, slowquery Aurora PostgreSQL Valid values: postgresql Valid for: Aurora DB clusters and Multi-AZ DB clusters

EnableGlobalWriteForwarding bool

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 bool

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:

Aurora PostgreSQL Serverless v2 and provisioned
Aurora PostgreSQL and Aurora MySQL Serverless v1

For more information, see Using RDS Data API in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only

EnableIamDatabaseAuthentication bool

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For more information, see IAM Database Authentication in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only

EnableLocalWriteForwarding bool

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

Endpoint Pulumi.AwsNative.Rds.Outputs.DbClusterEndpoint

Engine string

The name of the database engine to be used for this DB cluster. Valid Values:

aurora-mysql
aurora-postgresql
mysql
postgres

Valid for: Aurora DB clusters and Multi-AZ DB clusters

EngineLifecycleSupport string

The life cycle 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 to open-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 (PostgreSQL only) - Using Amazon RDS Extended Support in the Amazon Aurora User Guide
Amazon RDS - Using Amazon RDS Extended Support 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-disabled Default: open-source-rds-extended-support

EngineVersion string

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 (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" Aurora MySQL For information, see Database engine updates for Amazon Aurora MySQL in the Amazon Aurora User Guide. Aurora PostgreSQL For information, see Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide. MySQL For information, see Amazon RDS for MySQL in the Amazon RDS User Guide. PostgreSQL For information, see Amazon RDS for PostgreSQL in the Amazon RDS User Guide. Valid for: Aurora DB clusters and Multi-AZ DB clusters

GlobalClusterIdentifier string

If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster. To define the primary database cluster of the global cluster, use the AWS::RDS::GlobalCluster resource. If you aren't configuring a global database cluster, don't specify this property. To remove the DB cluster from a global database cluster, specify an empty value for the GlobalClusterIdentifier property. For information about Aurora global databases, see Working with Amazon Aurora Global Databases in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only

Iops int

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.

ManageMasterUserPassword bool

Specifies whether to manage the master user password with AWS Secrets Manager. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide and Password management with 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 AWS Secrets Manager if MasterUserPassword is specified.

MasterUserSecret Pulumi.AwsNative.Rds.Outputs.DbClusterMasterUserSecret

The secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide and Password management with Secrets Manager in the Amazon Aurora User Guide.

MasterUsername string

The name of the master user for the DB cluster. If you specify the SourceDBClusterIdentifier, SnapshotIdentifier, or GlobalClusterIdentifier property, don't specify this property. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively. Valid for: Aurora DB clusters and Multi-AZ DB clusters

MonitoringInterval int

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 string

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

NetworkType string

The network type of the DB cluster. Valid values:

IPV4
DUAL

The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and IPv6 protocols (DUAL). For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only

PerformanceInsightsEnabled bool

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 string

The AWS KMS key identifier for encryption of Performance Insights data. The AWS 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 AWS-account. Your AWS-account has a different default KMS key for each AWS-Region. Valid for Cluster Type: Multi-AZ DB clusters only

PerformanceInsightsRetentionPeriod int

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.

Port int

The port number on which the DB instances in the DB cluster accept connections. Default:

When EngineMode is provisioned, 3306 (for both Aurora MySQL and Aurora PostgreSQL)
When EngineMode is serverless:
3306 when Engine is aurora or aurora-mysql
5432 when Engine is aurora-postgresql

The No interruption on update behavior only applies to DB clusters. If you are updating a DB instance, see Port for the AWS::RDS::DBInstance resource. Valid for: Aurora DB clusters and Multi-AZ DB clusters

PreferredBackupWindow string

The daily time range during which automated backups are created. For more information, 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.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

PreferredMaintenanceWindow string

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a 30-minute window selected at random from an 8-hour block of time for each AWS 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. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window. Valid for: Aurora DB clusters and Multi-AZ DB clusters

ReadEndpoint Pulumi.AwsNative.Rds.Outputs.DbClusterReadEndpoint

This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions:

CreateDBInstance
DescribeDBInstances
DeleteDBInstance

For the data structure that represents Amazon Aurora DB cluster endpoints, see DBClusterEndpoint.

ReplicationSourceIdentifier string

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: Aurora DB clusters only

ScalingConfiguration Pulumi.AwsNative.Rds.Outputs.DbClusterScalingConfiguration

The scaling configuration of an Aurora Serverless v1 DB cluster. This property is only supported for Aurora Serverless v1. For Aurora Serverless v2, Use the ServerlessV2ScalingConfiguration property. Valid for: Aurora Serverless v1 DB clusters only

ServerlessV2ScalingConfiguration Pulumi.AwsNative.Rds.Outputs.DbClusterServerlessV2ScalingConfiguration

The scaling configuration of an Aurora Serverless V2 DB cluster. This property is only supported for Aurora Serverless v2. For Aurora Serverless v1, Use the ScalingConfiguration property. Valid for: Aurora Serverless v2 DB clusters only

StorageThroughput int

The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable.

This setting is only for non-Aurora Multi-AZ DB clusters.

StorageType string

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 | 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 to aurora.

Tags List<Pulumi.AwsNative.Outputs.Tag>

An optional array of key-value pairs to apply to this DB cluster. Valid for: Aurora DB clusters and Multi-AZ DB clusters

VpcSecurityGroupIds List<string>

A list of EC2 VPC security groups to associate with this DB cluster. If you plan to update the resource, don't specify VPC security groups in a shared VPC. Valid for: Aurora DB clusters and Multi-AZ DB clusters

AllocatedStorage int

AssociatedRoles []DbClusterDbClusterRole

AutoMinorVersionUpgrade bool

BacktrackWindow int

The target backtrack window, in seconds. To disable backtracking, set this value to 0. Currently, Backtrack is only supported for Aurora MySQL DB clusters. Default: 0 Constraints:

If specified, this value must be set to a number from 0 to 259,200 (72 hours).

Valid for: Aurora MySQL DB clusters only

BackupRetentionPeriod int

The number of days for which automated backups are retained. Default: 1 Constraints:

Must be a value from 1 to 35

Valid for: Aurora DB clusters and Multi-AZ DB clusters

CopyTagsToSnapshot bool

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them. Valid for: Aurora DB clusters and Multi-AZ DB clusters

DbClusterArn string

The Amazon Resource Name (ARN) for the DB cluster.

DbClusterInstanceClass string

DbClusterParameterGroupName string

aws rds describe-db-cluster-parameter-groups --query "DBClusterParameterGroups[].DBClusterParameterGroupName" --output text

Valid for: Aurora DB clusters and Multi-AZ DB clusters

DbClusterResourceId string

The AWS Region -unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB cluster is accessed.

DeletionProtection bool

Domain string

DomainIamRoleName string

Specifies the name of the IAM role to use when making API calls to the Directory Service. Valid for: Aurora DB clusters only

EnableCloudwatchLogsExports []string

EnableGlobalWriteForwarding bool

EnableHttpEndpoint bool

Aurora PostgreSQL Serverless v2 and provisioned
Aurora PostgreSQL and Aurora MySQL Serverless v1

For more information, see Using RDS Data API in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only

EnableIamDatabaseAuthentication bool

EnableLocalWriteForwarding bool

Endpoint DbClusterEndpoint

Engine string

The name of the database engine to be used for this DB cluster. Valid Values:

aurora-mysql
aurora-postgresql
mysql
postgres

Valid for: Aurora DB clusters and Multi-AZ DB clusters

EngineLifecycleSupport string

Amazon Aurora (PostgreSQL only) - Using Amazon RDS Extended Support in the Amazon Aurora User Guide
Amazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide

EngineVersion string

GlobalClusterIdentifier string

Iops int

Must be a multiple between .5 and 50 of the storage amount for the DB cluster.

ManageMasterUserPassword bool

Can't manage the master user password with AWS Secrets Manager if MasterUserPassword is specified.

MasterUserSecret DbClusterMasterUserSecret

MasterUsername string

MonitoringInterval int

MonitoringRoleArn string

NetworkType string

The network type of the DB cluster. Valid values:

IPV4
DUAL

PerformanceInsightsEnabled bool

PerformanceInsightsKmsKeyId string

PerformanceInsightsRetentionPeriod int

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.

Port int

The port number on which the DB instances in the DB cluster accept connections. Default:

When EngineMode is provisioned, 3306 (for both Aurora MySQL and Aurora PostgreSQL)
When EngineMode is serverless:
3306 when Engine is aurora or aurora-mysql
5432 when Engine is aurora-postgresql

PreferredBackupWindow string

The daily time range during which automated backups are created. For more information, 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.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

PreferredMaintenanceWindow string

ReadEndpoint DbClusterReadEndpoint

This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions:

CreateDBInstance
DescribeDBInstances
DeleteDBInstance

For the data structure that represents Amazon Aurora DB cluster endpoints, see DBClusterEndpoint.

ReplicationSourceIdentifier string

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: Aurora DB clusters only

ScalingConfiguration DbClusterScalingConfiguration

ServerlessV2ScalingConfiguration DbClusterServerlessV2ScalingConfiguration

StorageThroughput int

The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable.

This setting is only for non-Aurora Multi-AZ DB clusters.

StorageType string

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 to aurora.

Tags Tag

An optional array of key-value pairs to apply to this DB cluster. Valid for: Aurora DB clusters and Multi-AZ DB clusters

VpcSecurityGroupIds []string

allocatedStorage Integer

associatedRoles List<DbClusterDbClusterRole>

autoMinorVersionUpgrade Boolean

backtrackWindow Integer

The target backtrack window, in seconds. To disable backtracking, set this value to 0. Currently, Backtrack is only supported for Aurora MySQL DB clusters. Default: 0 Constraints:

If specified, this value must be set to a number from 0 to 259,200 (72 hours).

Valid for: Aurora MySQL DB clusters only

backupRetentionPeriod Integer

The number of days for which automated backups are retained. Default: 1 Constraints:

Must be a value from 1 to 35

Valid for: Aurora DB clusters and Multi-AZ DB clusters

copyTagsToSnapshot Boolean

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them. Valid for: Aurora DB clusters and Multi-AZ DB clusters

dbClusterArn String

The Amazon Resource Name (ARN) for the DB cluster.

dbClusterInstanceClass String

dbClusterParameterGroupName String

aws rds describe-db-cluster-parameter-groups --query "DBClusterParameterGroups[].DBClusterParameterGroupName" --output text

Valid for: Aurora DB clusters and Multi-AZ DB clusters

dbClusterResourceId String

The AWS Region -unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB cluster is accessed.

deletionProtection Boolean

domain String

domainIamRoleName String

Specifies the name of the IAM role to use when making API calls to the Directory Service. Valid for: Aurora DB clusters only

enableCloudwatchLogsExports List<String>

enableGlobalWriteForwarding Boolean

enableHttpEndpoint Boolean

Aurora PostgreSQL Serverless v2 and provisioned
Aurora PostgreSQL and Aurora MySQL Serverless v1

For more information, see Using RDS Data API in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only

enableIamDatabaseAuthentication Boolean

enableLocalWriteForwarding Boolean

endpoint DbClusterEndpoint

engine String

The name of the database engine to be used for this DB cluster. Valid Values:

aurora-mysql
aurora-postgresql
mysql
postgres

Valid for: Aurora DB clusters and Multi-AZ DB clusters

engineLifecycleSupport String

Amazon Aurora (PostgreSQL only) - Using Amazon RDS Extended Support in the Amazon Aurora User Guide
Amazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide

engineVersion String

globalClusterIdentifier String

iops Integer

Must be a multiple between .5 and 50 of the storage amount for the DB cluster.

manageMasterUserPassword Boolean

Can't manage the master user password with AWS Secrets Manager if MasterUserPassword is specified.

masterUserSecret DbClusterMasterUserSecret

masterUsername String

monitoringInterval Integer

monitoringRoleArn String

networkType String

The network type of the DB cluster. Valid values:

IPV4
DUAL

performanceInsightsEnabled Boolean

performanceInsightsKmsKeyId String

performanceInsightsRetentionPeriod Integer

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.

port Integer

The port number on which the DB instances in the DB cluster accept connections. Default:

When EngineMode is provisioned, 3306 (for both Aurora MySQL and Aurora PostgreSQL)
When EngineMode is serverless:
3306 when Engine is aurora or aurora-mysql
5432 when Engine is aurora-postgresql

preferredBackupWindow String

The daily time range during which automated backups are created. For more information, 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.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

preferredMaintenanceWindow String

readEndpoint DbClusterReadEndpoint

This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions:

CreateDBInstance
DescribeDBInstances
DeleteDBInstance

For the data structure that represents Amazon Aurora DB cluster endpoints, see DBClusterEndpoint.

replicationSourceIdentifier String

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: Aurora DB clusters only

scalingConfiguration DbClusterScalingConfiguration

serverlessV2ScalingConfiguration DbClusterServerlessV2ScalingConfiguration

storageThroughput Integer

The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable.

This setting is only for non-Aurora Multi-AZ DB clusters.

storageType String

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 to aurora.

tags List<Tag>

An optional array of key-value pairs to apply to this DB cluster. Valid for: Aurora DB clusters and Multi-AZ DB clusters

vpcSecurityGroupIds List<String>

allocatedStorage number

associatedRoles DbClusterDbClusterRole[]

autoMinorVersionUpgrade boolean

backtrackWindow number

The target backtrack window, in seconds. To disable backtracking, set this value to 0. Currently, Backtrack is only supported for Aurora MySQL DB clusters. Default: 0 Constraints:

If specified, this value must be set to a number from 0 to 259,200 (72 hours).

Valid for: Aurora MySQL DB clusters only

backupRetentionPeriod number

The number of days for which automated backups are retained. Default: 1 Constraints:

Must be a value from 1 to 35

Valid for: Aurora DB clusters and Multi-AZ DB clusters

copyTagsToSnapshot boolean

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them. Valid for: Aurora DB clusters and Multi-AZ DB clusters

dbClusterArn string

The Amazon Resource Name (ARN) for the DB cluster.

dbClusterInstanceClass string

dbClusterParameterGroupName string

aws rds describe-db-cluster-parameter-groups --query "DBClusterParameterGroups[].DBClusterParameterGroupName" --output text

Valid for: Aurora DB clusters and Multi-AZ DB clusters

dbClusterResourceId string

The AWS Region -unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB cluster is accessed.

deletionProtection boolean

domain string

domainIamRoleName string

Specifies the name of the IAM role to use when making API calls to the Directory Service. Valid for: Aurora DB clusters only

enableCloudwatchLogsExports string[]

enableGlobalWriteForwarding boolean

enableHttpEndpoint boolean

Aurora PostgreSQL Serverless v2 and provisioned
Aurora PostgreSQL and Aurora MySQL Serverless v1

For more information, see Using RDS Data API in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only

enableIamDatabaseAuthentication boolean

enableLocalWriteForwarding boolean

endpoint DbClusterEndpoint

engine string

The name of the database engine to be used for this DB cluster. Valid Values:

aurora-mysql
aurora-postgresql
mysql
postgres

Valid for: Aurora DB clusters and Multi-AZ DB clusters

engineLifecycleSupport string

Amazon Aurora (PostgreSQL only) - Using Amazon RDS Extended Support in the Amazon Aurora User Guide
Amazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide

engineVersion string

globalClusterIdentifier string

iops number

Must be a multiple between .5 and 50 of the storage amount for the DB cluster.

manageMasterUserPassword boolean

Can't manage the master user password with AWS Secrets Manager if MasterUserPassword is specified.

masterUserSecret DbClusterMasterUserSecret

masterUsername string

monitoringInterval number

monitoringRoleArn string

networkType string

The network type of the DB cluster. Valid values:

IPV4
DUAL

performanceInsightsEnabled boolean

performanceInsightsKmsKeyId string

performanceInsightsRetentionPeriod number

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.

port number

The port number on which the DB instances in the DB cluster accept connections. Default:

When EngineMode is provisioned, 3306 (for both Aurora MySQL and Aurora PostgreSQL)
When EngineMode is serverless:
3306 when Engine is aurora or aurora-mysql
5432 when Engine is aurora-postgresql

preferredBackupWindow string

The daily time range during which automated backups are created. For more information, 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.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

preferredMaintenanceWindow string

readEndpoint DbClusterReadEndpoint

This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions:

CreateDBInstance
DescribeDBInstances
DeleteDBInstance

For the data structure that represents Amazon Aurora DB cluster endpoints, see DBClusterEndpoint.

replicationSourceIdentifier string

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: Aurora DB clusters only

scalingConfiguration DbClusterScalingConfiguration

serverlessV2ScalingConfiguration DbClusterServerlessV2ScalingConfiguration

storageThroughput number

The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable.

This setting is only for non-Aurora Multi-AZ DB clusters.

storageType string

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 to aurora.

tags Tag[]

An optional array of key-value pairs to apply to this DB cluster. Valid for: Aurora DB clusters and Multi-AZ DB clusters

vpcSecurityGroupIds string[]

allocated_storage int

associated_roles Sequence[DbClusterDbClusterRole]

auto_minor_version_upgrade bool

backtrack_window int

The target backtrack window, in seconds. To disable backtracking, set this value to 0. Currently, Backtrack is only supported for Aurora MySQL DB clusters. Default: 0 Constraints:

If specified, this value must be set to a number from 0 to 259,200 (72 hours).

Valid for: Aurora MySQL DB clusters only

backup_retention_period int

The number of days for which automated backups are retained. Default: 1 Constraints:

Must be a value from 1 to 35

Valid for: Aurora DB clusters and Multi-AZ DB clusters

copy_tags_to_snapshot bool

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them. Valid for: Aurora DB clusters and Multi-AZ DB clusters

db_cluster_arn str

The Amazon Resource Name (ARN) for the DB cluster.

db_cluster_instance_class str

db_cluster_parameter_group_name str

aws rds describe-db-cluster-parameter-groups --query "DBClusterParameterGroups[].DBClusterParameterGroupName" --output text

Valid for: Aurora DB clusters and Multi-AZ DB clusters

db_cluster_resource_id str

The AWS Region -unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB cluster is accessed.

deletion_protection bool

domain str

domain_iam_role_name str

Specifies the name of the IAM role to use when making API calls to the Directory Service. Valid for: Aurora DB clusters only

enable_cloudwatch_logs_exports Sequence[str]

enable_global_write_forwarding bool

enable_http_endpoint bool

Aurora PostgreSQL Serverless v2 and provisioned
Aurora PostgreSQL and Aurora MySQL Serverless v1

For more information, see Using RDS Data API in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only

enable_iam_database_authentication bool

enable_local_write_forwarding bool

endpoint DbClusterEndpoint

engine str

The name of the database engine to be used for this DB cluster. Valid Values:

aurora-mysql
aurora-postgresql
mysql
postgres

Valid for: Aurora DB clusters and Multi-AZ DB clusters

engine_lifecycle_support str

Amazon Aurora (PostgreSQL only) - Using Amazon RDS Extended Support in the Amazon Aurora User Guide
Amazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide

engine_version str

global_cluster_identifier str

iops int

Must be a multiple between .5 and 50 of the storage amount for the DB cluster.

manage_master_user_password bool

Can't manage the master user password with AWS Secrets Manager if MasterUserPassword is specified.

master_user_secret DbClusterMasterUserSecret

master_username str

monitoring_interval int

monitoring_role_arn str

network_type str

The network type of the DB cluster. Valid values:

IPV4
DUAL

performance_insights_enabled bool

performance_insights_kms_key_id str

performance_insights_retention_period int

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.

port int

The port number on which the DB instances in the DB cluster accept connections. Default:

When EngineMode is provisioned, 3306 (for both Aurora MySQL and Aurora PostgreSQL)
When EngineMode is serverless:
3306 when Engine is aurora or aurora-mysql
5432 when Engine is aurora-postgresql

preferred_backup_window str

The daily time range during which automated backups are created. For more information, 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.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

preferred_maintenance_window str

read_endpoint DbClusterReadEndpoint

This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions:

CreateDBInstance
DescribeDBInstances
DeleteDBInstance

For the data structure that represents Amazon Aurora DB cluster endpoints, see DBClusterEndpoint.

replication_source_identifier str

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: Aurora DB clusters only

scaling_configuration DbClusterScalingConfiguration

serverless_v2_scaling_configuration DbClusterServerlessV2ScalingConfiguration

storage_throughput int

The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable.

This setting is only for non-Aurora Multi-AZ DB clusters.

storage_type str

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 to aurora.

tags Sequence[root_Tag]

An optional array of key-value pairs to apply to this DB cluster. Valid for: Aurora DB clusters and Multi-AZ DB clusters

vpc_security_group_ids Sequence[str]

allocatedStorage Number

associatedRoles List<Property Map>

autoMinorVersionUpgrade Boolean

backtrackWindow Number

The target backtrack window, in seconds. To disable backtracking, set this value to 0. Currently, Backtrack is only supported for Aurora MySQL DB clusters. Default: 0 Constraints:

If specified, this value must be set to a number from 0 to 259,200 (72 hours).

Valid for: Aurora MySQL DB clusters only

backupRetentionPeriod Number

The number of days for which automated backups are retained. Default: 1 Constraints:

Must be a value from 1 to 35

Valid for: Aurora DB clusters and Multi-AZ DB clusters

copyTagsToSnapshot Boolean

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them. Valid for: Aurora DB clusters and Multi-AZ DB clusters

dbClusterArn String

The Amazon Resource Name (ARN) for the DB cluster.

dbClusterInstanceClass String

dbClusterParameterGroupName String

aws rds describe-db-cluster-parameter-groups --query "DBClusterParameterGroups[].DBClusterParameterGroupName" --output text

Valid for: Aurora DB clusters and Multi-AZ DB clusters

dbClusterResourceId String

The AWS Region -unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB cluster is accessed.

deletionProtection Boolean

domain String

domainIamRoleName String

Specifies the name of the IAM role to use when making API calls to the Directory Service. Valid for: Aurora DB clusters only

enableCloudwatchLogsExports List<String>

enableGlobalWriteForwarding Boolean

enableHttpEndpoint Boolean

Aurora PostgreSQL Serverless v2 and provisioned
Aurora PostgreSQL and Aurora MySQL Serverless v1

For more information, see Using RDS Data API in the Amazon Aurora User Guide. Valid for Cluster Type: Aurora DB clusters only

enableIamDatabaseAuthentication Boolean

enableLocalWriteForwarding Boolean

endpoint Property Map

engine String

The name of the database engine to be used for this DB cluster. Valid Values:

aurora-mysql
aurora-postgresql
mysql
postgres

Valid for: Aurora DB clusters and Multi-AZ DB clusters

engineLifecycleSupport String

Amazon Aurora (PostgreSQL only) - Using Amazon RDS Extended Support in the Amazon Aurora User Guide
Amazon RDS - Using Amazon RDS Extended Support in the Amazon RDS User Guide

engineVersion String

globalClusterIdentifier String

iops Number

Must be a multiple between .5 and 50 of the storage amount for the DB cluster.

manageMasterUserPassword Boolean

Can't manage the master user password with AWS Secrets Manager if MasterUserPassword is specified.

masterUserSecret Property Map

masterUsername String

monitoringInterval Number

monitoringRoleArn String

networkType String

The network type of the DB cluster. Valid values:

IPV4
DUAL

performanceInsightsEnabled Boolean

performanceInsightsKmsKeyId String

performanceInsightsRetentionPeriod Number

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.

port Number

The port number on which the DB instances in the DB cluster accept connections. Default:

When EngineMode is provisioned, 3306 (for both Aurora MySQL and Aurora PostgreSQL)
When EngineMode is serverless:
3306 when Engine is aurora or aurora-mysql
5432 when Engine is aurora-postgresql

preferredBackupWindow String

The daily time range during which automated backups are created. For more information, 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.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

preferredMaintenanceWindow String

readEndpoint Property Map

This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions:

CreateDBInstance
DescribeDBInstances
DeleteDBInstance

For the data structure that represents Amazon Aurora DB cluster endpoints, see DBClusterEndpoint.

replicationSourceIdentifier String

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: Aurora DB clusters only

scalingConfiguration Property Map

serverlessV2ScalingConfiguration Property Map

storageThroughput Number

The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable.

This setting is only for non-Aurora Multi-AZ DB clusters.

storageType String

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 to aurora.

tags List<Property Map>

An optional array of key-value pairs to apply to this DB cluster. Valid for: Aurora DB clusters and Multi-AZ DB clusters

vpcSecurityGroupIds List<String>

Supporting Types

DbClusterDbClusterRole

RoleArn string: The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
FeatureName string: The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf. For the list of supported feature names, see the SupportedFeatureNames description in DBEngineVersion in the Amazon RDS API Reference.

RoleArn string: The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
FeatureName string: The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf. For the list of supported feature names, see the SupportedFeatureNames description in DBEngineVersion in the Amazon RDS API Reference.

roleArn String: The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
featureName String: The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf. For the list of supported feature names, see the SupportedFeatureNames description in DBEngineVersion in the Amazon RDS API Reference.

roleArn string: The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
featureName string: The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf. For the list of supported feature names, see the SupportedFeatureNames description in DBEngineVersion in the Amazon RDS API Reference.

role_arn str: The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
feature_name str: The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf. For the list of supported feature names, see the SupportedFeatureNames description in DBEngineVersion in the Amazon RDS API Reference.

roleArn String: The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
featureName String: The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf. For the list of supported feature names, see the SupportedFeatureNames description in DBEngineVersion in the Amazon RDS API Reference.

DbClusterEndpoint

Address string: Specifies the connection endpoint for the primary instance of the DB cluster.
Port string: Specifies the port that the database engine is listening on.

Address string: Specifies the connection endpoint for the primary instance of the DB cluster.
Port string: Specifies the port that the database engine is listening on.

address String: Specifies the connection endpoint for the primary instance of the DB cluster.
port String: Specifies the port that the database engine is listening on.

address string: Specifies the connection endpoint for the primary instance of the DB cluster.
port string: Specifies the port that the database engine is listening on.

address str: Specifies the connection endpoint for the primary instance of the DB cluster.
port str: Specifies the port that the database engine is listening on.

address String: Specifies the connection endpoint for the primary instance of the DB cluster.
port String: Specifies the port that the database engine is listening on.

DbClusterMasterUserSecret

KmsKeyId string: The AWS KMS key identifier that is used to encrypt the secret.
SecretArn string: The Amazon Resource Name (ARN) of the secret. This parameter is a return value that you can retrieve using the Fn::GetAtt intrinsic function. For more information, see Return values.

KmsKeyId string: The AWS KMS key identifier that is used to encrypt the secret.
SecretArn string: The Amazon Resource Name (ARN) of the secret. This parameter is a return value that you can retrieve using the Fn::GetAtt intrinsic function. For more information, see Return values.

kmsKeyId String: The AWS KMS key identifier that is used to encrypt the secret.
secretArn String: The Amazon Resource Name (ARN) of the secret. This parameter is a return value that you can retrieve using the Fn::GetAtt intrinsic function. For more information, see Return values.

kmsKeyId string: The AWS KMS key identifier that is used to encrypt the secret.
secretArn string: The Amazon Resource Name (ARN) of the secret. This parameter is a return value that you can retrieve using the Fn::GetAtt intrinsic function. For more information, see Return values.

kms_key_id str: The AWS KMS key identifier that is used to encrypt the secret.
secret_arn str: The Amazon Resource Name (ARN) of the secret. This parameter is a return value that you can retrieve using the Fn::GetAtt intrinsic function. For more information, see Return values.

kmsKeyId String: The AWS KMS key identifier that is used to encrypt the secret.
secretArn String: The Amazon Resource Name (ARN) of the secret. This parameter is a return value that you can retrieve using the Fn::GetAtt intrinsic function. For more information, see Return values.

DbClusterReadEndpoint

Address string: The host address of the reader endpoint.

Address string: The host address of the reader endpoint.

address String: The host address of the reader endpoint.

address string: The host address of the reader endpoint.

address str: The host address of the reader endpoint.

address String: The host address of the reader endpoint.

DbClusterScalingConfiguration

AutoPause bool: Indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections). If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.
MaxCapacity int: The maximum capacity for an Aurora DB cluster in serverless DB engine mode. For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. The maximum capacity must be greater than or equal to the minimum capacity.
MinCapacity int: The minimum capacity for an Aurora DB cluster in serverless DB engine mode. For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. The minimum capacity must be less than or equal to the maximum capacity.
SecondsBeforeTimeout int: The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300. Specify a value between 60 and 600 seconds.
SecondsUntilAutoPause int: The time, in seconds, before an Aurora DB cluster in serverless mode is paused. Specify a value between 300 and 86,400 seconds.
TimeoutAction string: The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange. ForceApplyCapacityChange sets the capacity to the specified value as soon as possible. RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period. If you specify ForceApplyCapacityChange, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.

AutoPause bool: Indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections). If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.
MaxCapacity int: The maximum capacity for an Aurora DB cluster in serverless DB engine mode. For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. The maximum capacity must be greater than or equal to the minimum capacity.
MinCapacity int: The minimum capacity for an Aurora DB cluster in serverless DB engine mode. For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. The minimum capacity must be less than or equal to the maximum capacity.
SecondsBeforeTimeout int: The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300. Specify a value between 60 and 600 seconds.
SecondsUntilAutoPause int: The time, in seconds, before an Aurora DB cluster in serverless mode is paused. Specify a value between 300 and 86,400 seconds.
TimeoutAction string: The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange. ForceApplyCapacityChange sets the capacity to the specified value as soon as possible. RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period. If you specify ForceApplyCapacityChange, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.

autoPause Boolean: Indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections). If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.
maxCapacity Integer: The maximum capacity for an Aurora DB cluster in serverless DB engine mode. For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. The maximum capacity must be greater than or equal to the minimum capacity.
minCapacity Integer: The minimum capacity for an Aurora DB cluster in serverless DB engine mode. For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. The minimum capacity must be less than or equal to the maximum capacity.
secondsBeforeTimeout Integer: The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300. Specify a value between 60 and 600 seconds.
secondsUntilAutoPause Integer: The time, in seconds, before an Aurora DB cluster in serverless mode is paused. Specify a value between 300 and 86,400 seconds.
timeoutAction String: The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange. ForceApplyCapacityChange sets the capacity to the specified value as soon as possible. RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period. If you specify ForceApplyCapacityChange, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.

autoPause boolean: Indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections). If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.
maxCapacity number: The maximum capacity for an Aurora DB cluster in serverless DB engine mode. For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. The maximum capacity must be greater than or equal to the minimum capacity.
minCapacity number: The minimum capacity for an Aurora DB cluster in serverless DB engine mode. For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. The minimum capacity must be less than or equal to the maximum capacity.
secondsBeforeTimeout number: The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300. Specify a value between 60 and 600 seconds.
secondsUntilAutoPause number: The time, in seconds, before an Aurora DB cluster in serverless mode is paused. Specify a value between 300 and 86,400 seconds.
timeoutAction string: The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange. ForceApplyCapacityChange sets the capacity to the specified value as soon as possible. RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period. If you specify ForceApplyCapacityChange, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.

auto_pause bool: Indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections). If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.
max_capacity int: The maximum capacity for an Aurora DB cluster in serverless DB engine mode. For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. The maximum capacity must be greater than or equal to the minimum capacity.
min_capacity int: The minimum capacity for an Aurora DB cluster in serverless DB engine mode. For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. The minimum capacity must be less than or equal to the maximum capacity.
seconds_before_timeout int: The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300. Specify a value between 60 and 600 seconds.
seconds_until_auto_pause int: The time, in seconds, before an Aurora DB cluster in serverless mode is paused. Specify a value between 300 and 86,400 seconds.
timeout_action str: The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange. ForceApplyCapacityChange sets the capacity to the specified value as soon as possible. RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period. If you specify ForceApplyCapacityChange, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.

autoPause Boolean: Indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections). If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.
maxCapacity Number: The maximum capacity for an Aurora DB cluster in serverless DB engine mode. For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. The maximum capacity must be greater than or equal to the minimum capacity.
minCapacity Number: The minimum capacity for an Aurora DB cluster in serverless DB engine mode. For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. The minimum capacity must be less than or equal to the maximum capacity.
secondsBeforeTimeout Number: The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300. Specify a value between 60 and 600 seconds.
secondsUntilAutoPause Number: The time, in seconds, before an Aurora DB cluster in serverless mode is paused. Specify a value between 300 and 86,400 seconds.
timeoutAction String: The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange. ForceApplyCapacityChange sets the capacity to the specified value as soon as possible. RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period. If you specify ForceApplyCapacityChange, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.

DbClusterServerlessV2ScalingConfiguration

MaxCapacity double: The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128. The maximum capacity must be higher than 0.5 ACUs. For more information, see Choosing the maximum Aurora Serverless v2 capacity setting for a cluster in the Amazon Aurora User Guide. Aurora automatically sets certain parameters for Aurora Serverless V2 DB instances to values that depend on the maximum ACU value in the capacity range. When you update the maximum capacity value, the ParameterApplyStatus value for the DB instance changes to pending-reboot. You can update the parameter values by rebooting the DB instance after changing the capacity range.
MinCapacity double: The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.

MaxCapacity float64: The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128. The maximum capacity must be higher than 0.5 ACUs. For more information, see Choosing the maximum Aurora Serverless v2 capacity setting for a cluster in the Amazon Aurora User Guide. Aurora automatically sets certain parameters for Aurora Serverless V2 DB instances to values that depend on the maximum ACU value in the capacity range. When you update the maximum capacity value, the ParameterApplyStatus value for the DB instance changes to pending-reboot. You can update the parameter values by rebooting the DB instance after changing the capacity range.
MinCapacity float64: The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.

maxCapacity Double: The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128. The maximum capacity must be higher than 0.5 ACUs. For more information, see Choosing the maximum Aurora Serverless v2 capacity setting for a cluster in the Amazon Aurora User Guide. Aurora automatically sets certain parameters for Aurora Serverless V2 DB instances to values that depend on the maximum ACU value in the capacity range. When you update the maximum capacity value, the ParameterApplyStatus value for the DB instance changes to pending-reboot. You can update the parameter values by rebooting the DB instance after changing the capacity range.
minCapacity Double: The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.

maxCapacity number: The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128. The maximum capacity must be higher than 0.5 ACUs. For more information, see Choosing the maximum Aurora Serverless v2 capacity setting for a cluster in the Amazon Aurora User Guide. Aurora automatically sets certain parameters for Aurora Serverless V2 DB instances to values that depend on the maximum ACU value in the capacity range. When you update the maximum capacity value, the ParameterApplyStatus value for the DB instance changes to pending-reboot. You can update the parameter values by rebooting the DB instance after changing the capacity range.
minCapacity number: The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.

max_capacity float: The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128. The maximum capacity must be higher than 0.5 ACUs. For more information, see Choosing the maximum Aurora Serverless v2 capacity setting for a cluster in the Amazon Aurora User Guide. Aurora automatically sets certain parameters for Aurora Serverless V2 DB instances to values that depend on the maximum ACU value in the capacity range. When you update the maximum capacity value, the ParameterApplyStatus value for the DB instance changes to pending-reboot. You can update the parameter values by rebooting the DB instance after changing the capacity range.
min_capacity float: The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.

maxCapacity Number: The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128. The maximum capacity must be higher than 0.5 ACUs. For more information, see Choosing the maximum Aurora Serverless v2 capacity setting for a cluster in the Amazon Aurora User Guide. Aurora automatically sets certain parameters for Aurora Serverless V2 DB instances to values that depend on the maximum ACU value in the capacity range. When you update the maximum capacity value, the ParameterApplyStatus value for the DB instance changes to pending-reboot. You can update the parameter values by rebooting the DB instance after changing the capacity range.
minCapacity Number: The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.rds.getDbCluster

On this page

On this page

Using getDbCluster

getDbCluster Result

Supporting Types

DbClusterDbClusterRole

DbClusterEndpoint

DbClusterMasterUserSecret

DbClusterReadEndpoint

DbClusterScalingConfiguration

DbClusterServerlessV2ScalingConfiguration

Tag

Package Details

On this page

On this page