aws-native.rds.getDBCluster
Explore with Pulumi AI
The AWS::RDS::DBCluster resource creates an Amazon Aurora DB cluster.
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(d_b_cluster_identifier: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetDBClusterResult
def get_db_cluster_output(d_b_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:
- DBCluster
Identifier string The DB cluster identifier. This parameter is stored as a lowercase string.
- DBCluster
Identifier string The DB cluster identifier. This parameter is stored as a lowercase string.
- d
BCluster StringIdentifier The DB cluster identifier. This parameter is stored as a lowercase string.
- d
BCluster stringIdentifier The DB cluster identifier. This parameter is stored as a lowercase string.
- d_
b_ strcluster_ identifier The DB cluster identifier. This parameter is stored as a lowercase string.
- d
BCluster StringIdentifier The DB cluster identifier. This parameter is stored as a lowercase string.
getDBCluster Result
The following output properties are available:
- Allocated
Storage int The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
- Associated
Roles List<Pulumi.Aws Native. RDS. Outputs. DBCluster Role> 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 AWS services on your behalf.
- Auto
Minor boolVersion Upgrade A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.
- Backtrack
Window int The target backtrack window, in seconds. To disable backtracking, set this value to 0.
- Backup
Retention intPeriod The number of days for which automated backups are retained.
- 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.
- DBCluster
Arn string The Amazon Resource Name (ARN) for the DB cluster.
- DBCluster
Instance stringClass The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.
- DBCluster
Parameter stringGroup Name The name of the DB cluster parameter group to associate with this DB cluster.
- DBCluster
Resource stringId The AWS Region-unique, immutable identifier for the DB cluster.
- Deletion
Protection 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.
- Domain string
The Active Directory directory ID to create the DB cluster in.
- Domain
IAMRole stringName Specify the name of the IAM role to be used when making API calls to the Directory Service.
- Enable
Cloudwatch List<string>Logs Exports 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.
- Enable
Http boolEndpoint A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.
- Enable
IAMDatabase boolAuthentication A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
- Endpoint
Pulumi.
Aws Native. RDS. Outputs. DBCluster Endpoint - Engine string
The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql
- Engine
Version string The version number of the database engine to use.
- Global
Cluster stringIdentifier 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.
- 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.
- Manage
Master boolUser Password A value that indicates whether to manage the master user password with AWS Secrets Manager.
- Master
User Pulumi.Secret Aws Native. RDS. Outputs. DBCluster Master User Secret Contains the secret managed by RDS in AWS Secrets Manager for the master user password.
- Master
Username string The name of the master user for the DB cluster. You must specify MasterUsername, unless you specify SnapshotIdentifier. In that case, don't specify MasterUsername.
- Monitoring
Interval 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. The default is 0.
- Monitoring
Role stringArn The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
- Network
Type string The network type of the DB cluster.
- Performance
Insights boolEnabled A value that indicates whether to turn on Performance Insights for the DB cluster.
- Performance
Insights stringKms Key Id The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
- Performance
Insights intRetention Period The amount of time, in days, to retain Performance Insights data.
- Port int
The port number on which the instances in the DB cluster accept connections. Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.
- Preferred
Backup stringWindow The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
- Preferred
Maintenance stringWindow The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). 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.
- Read
Endpoint Pulumi.Aws Native. RDS. Outputs. DBCluster Read Endpoint - Replication
Source stringIdentifier The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.
- Scaling
Configuration Pulumi.Aws Native. RDS. Outputs. DBCluster Scaling Configuration The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster.
- Serverless
V2Scaling Pulumi.Configuration Aws Native. RDS. Outputs. DBCluster Serverless V2Scaling Configuration Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
- Storage
Type string Specifies the storage type to be associated with the DB cluster.
- List<Pulumi.
Aws Native. RDS. Outputs. DBCluster Tag> An array of key-value pairs to apply to this resource.
- Vpc
Security List<string>Group Ids A list of EC2 VPC security groups to associate with this DB cluster.
- Allocated
Storage int The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
- Associated
Roles []DBClusterRole 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 AWS services on your behalf.
- Auto
Minor boolVersion Upgrade A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.
- Backtrack
Window int The target backtrack window, in seconds. To disable backtracking, set this value to 0.
- Backup
Retention intPeriod The number of days for which automated backups are retained.
- 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.
- DBCluster
Arn string The Amazon Resource Name (ARN) for the DB cluster.
- DBCluster
Instance stringClass The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.
- DBCluster
Parameter stringGroup Name The name of the DB cluster parameter group to associate with this DB cluster.
- DBCluster
Resource stringId The AWS Region-unique, immutable identifier for the DB cluster.
- Deletion
Protection 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.
- Domain string
The Active Directory directory ID to create the DB cluster in.
- Domain
IAMRole stringName Specify the name of the IAM role to be used when making API calls to the Directory Service.
- Enable
Cloudwatch []stringLogs Exports 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.
- Enable
Http boolEndpoint A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.
- Enable
IAMDatabase boolAuthentication A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
- Endpoint
DBCluster
Endpoint - Engine string
The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql
- Engine
Version string The version number of the database engine to use.
- Global
Cluster stringIdentifier 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.
- 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.
- Manage
Master boolUser Password A value that indicates whether to manage the master user password with AWS Secrets Manager.
- Master
User DBClusterSecret Master User Secret Contains the secret managed by RDS in AWS Secrets Manager for the master user password.
- Master
Username string The name of the master user for the DB cluster. You must specify MasterUsername, unless you specify SnapshotIdentifier. In that case, don't specify MasterUsername.
- Monitoring
Interval 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. The default is 0.
- Monitoring
Role stringArn The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
- Network
Type string The network type of the DB cluster.
- Performance
Insights boolEnabled A value that indicates whether to turn on Performance Insights for the DB cluster.
- Performance
Insights stringKms Key Id The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
- Performance
Insights intRetention Period The amount of time, in days, to retain Performance Insights data.
- Port int
The port number on which the instances in the DB cluster accept connections. Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.
- Preferred
Backup stringWindow The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
- Preferred
Maintenance stringWindow The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). 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.
- Read
Endpoint DBClusterRead Endpoint - Replication
Source stringIdentifier The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.
- Scaling
Configuration DBClusterScaling Configuration The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster.
- Serverless
V2Scaling DBClusterConfiguration Serverless V2Scaling Configuration Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
- Storage
Type string Specifies the storage type to be associated with the DB cluster.
- []DBCluster
Tag An array of key-value pairs to apply to this resource.
- Vpc
Security []stringGroup Ids A list of EC2 VPC security groups to associate with this DB cluster.
- allocated
Storage Integer The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
- associated
Roles List<DBClusterRole> 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 AWS services on your behalf.
- auto
Minor BooleanVersion Upgrade A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.
- backtrack
Window Integer The target backtrack window, in seconds. To disable backtracking, set this value to 0.
- backup
Retention IntegerPeriod The number of days for which automated backups are retained.
- 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.
- d
BCluster StringArn The Amazon Resource Name (ARN) for the DB cluster.
- d
BCluster StringInstance Class The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.
- d
BCluster StringParameter Group Name The name of the DB cluster parameter group to associate with this DB cluster.
- d
BCluster StringResource Id The AWS Region-unique, immutable identifier for the DB cluster.
- deletion
Protection Boolean 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.
- domain String
The Active Directory directory ID to create the DB cluster in.
- domain
IAMRole StringName Specify the name of the IAM role to be used when making API calls to the Directory Service.
- enable
Cloudwatch List<String>Logs Exports 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.
- enable
Http BooleanEndpoint A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.
- enable
IAMDatabase BooleanAuthentication A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
- endpoint
DBCluster
Endpoint - engine String
The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql
- engine
Version String The version number of the database engine to use.
- global
Cluster StringIdentifier 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.
- iops Integer
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
- manage
Master BooleanUser Password A value that indicates whether to manage the master user password with AWS Secrets Manager.
- master
User DBClusterSecret Master User Secret Contains the secret managed by RDS in AWS Secrets Manager for the master user password.
- master
Username String The name of the master user for the DB cluster. You must specify MasterUsername, unless you specify SnapshotIdentifier. In that case, don't specify MasterUsername.
- monitoring
Interval Integer 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. The default is 0.
- monitoring
Role StringArn The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
- network
Type String The network type of the DB cluster.
- performance
Insights BooleanEnabled A value that indicates whether to turn on Performance Insights for the DB cluster.
- performance
Insights StringKms Key Id The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
- performance
Insights IntegerRetention Period The amount of time, in days, to retain Performance Insights data.
- port Integer
The port number on which the instances in the DB cluster accept connections. Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.
- preferred
Backup StringWindow The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
- preferred
Maintenance StringWindow The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). 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.
- read
Endpoint DBClusterRead Endpoint - replication
Source StringIdentifier The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.
- scaling
Configuration DBClusterScaling Configuration The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster.
- serverless
V2Scaling DBClusterConfiguration Serverless V2Scaling Configuration Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
- storage
Type String Specifies the storage type to be associated with the DB cluster.
- List<DBCluster
Tag> An array of key-value pairs to apply to this resource.
- vpc
Security List<String>Group Ids A list of EC2 VPC security groups to associate with this DB cluster.
- allocated
Storage number The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
- associated
Roles DBClusterRole[] 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 AWS services on your behalf.
- auto
Minor booleanVersion Upgrade A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.
- backtrack
Window number The target backtrack window, in seconds. To disable backtracking, set this value to 0.
- backup
Retention numberPeriod The number of days for which automated backups are retained.
- 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.
- d
BCluster stringArn The Amazon Resource Name (ARN) for the DB cluster.
- d
BCluster stringInstance Class The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.
- d
BCluster stringParameter Group Name The name of the DB cluster parameter group to associate with this DB cluster.
- d
BCluster stringResource Id The AWS Region-unique, immutable identifier for the DB cluster.
- deletion
Protection boolean 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.
- domain string
The Active Directory directory ID to create the DB cluster in.
- domain
IAMRole stringName Specify the name of the IAM role to be used when making API calls to the Directory Service.
- enable
Cloudwatch string[]Logs Exports 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.
- enable
Http booleanEndpoint A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.
- enable
IAMDatabase booleanAuthentication A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
- endpoint
DBCluster
Endpoint - engine string
The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql
- engine
Version string The version number of the database engine to use.
- global
Cluster stringIdentifier 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.
- iops number
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
- manage
Master booleanUser Password A value that indicates whether to manage the master user password with AWS Secrets Manager.
- master
User DBClusterSecret Master User Secret Contains the secret managed by RDS in AWS Secrets Manager for the master user password.
- master
Username string The name of the master user for the DB cluster. You must specify MasterUsername, unless you specify SnapshotIdentifier. In that case, don't specify MasterUsername.
- monitoring
Interval number 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. The default is 0.
- monitoring
Role stringArn The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
- network
Type string The network type of the DB cluster.
- performance
Insights booleanEnabled A value that indicates whether to turn on Performance Insights for the DB cluster.
- performance
Insights stringKms Key Id The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
- performance
Insights numberRetention Period The amount of time, in days, to retain Performance Insights data.
- port number
The port number on which the instances in the DB cluster accept connections. Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.
- preferred
Backup stringWindow The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
- preferred
Maintenance stringWindow The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). 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.
- read
Endpoint DBClusterRead Endpoint - replication
Source stringIdentifier The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.
- scaling
Configuration DBClusterScaling Configuration The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster.
- serverless
V2Scaling DBClusterConfiguration Serverless V2Scaling Configuration Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
- storage
Type string Specifies the storage type to be associated with the DB cluster.
- DBCluster
Tag[] An array of key-value pairs to apply to this resource.
- vpc
Security string[]Group Ids A list of EC2 VPC security groups to associate with this DB cluster.
- allocated_
storage int The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
- associated_
roles Sequence[DBClusterRole] 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 AWS services on your behalf.
- auto_
minor_ boolversion_ upgrade A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.
- backtrack_
window int The target backtrack window, in seconds. To disable backtracking, set this value to 0.
- backup_
retention_ intperiod The number of days for which automated backups are retained.
- 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.
- d_
b_ strcluster_ arn The Amazon Resource Name (ARN) for the DB cluster.
- d_
b_ strcluster_ instance_ class The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.
- d_
b_ strcluster_ parameter_ group_ name The name of the DB cluster parameter group to associate with this DB cluster.
- d_
b_ strcluster_ resource_ id The AWS Region-unique, immutable identifier for the DB cluster.
- deletion_
protection 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.
- domain str
The Active Directory directory ID to create the DB cluster in.
- domain_
iam_ strrole_ name Specify the name of the IAM role to be used when making API calls to the Directory Service.
- enable_
cloudwatch_ Sequence[str]logs_ exports 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.
- enable_
http_ boolendpoint A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.
- enable_
iam_ booldatabase_ authentication A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
- endpoint
DBCluster
Endpoint - engine str
The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql
- engine_
version str The version number of the database engine to use.
- global_
cluster_ stridentifier 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.
- 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.
- manage_
master_ booluser_ password A value that indicates whether to manage the master user password with AWS Secrets Manager.
- master_
user_ DBClustersecret Master User Secret Contains the secret managed by RDS in AWS Secrets Manager for the master user password.
- master_
username str The name of the master user for the DB cluster. You must specify MasterUsername, unless you specify SnapshotIdentifier. In that case, don't specify MasterUsername.
- monitoring_
interval 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. The default is 0.
- monitoring_
role_ strarn The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
- network_
type str The network type of the DB cluster.
- performance_
insights_ boolenabled A value that indicates whether to turn on Performance Insights for the DB cluster.
- performance_
insights_ strkms_ key_ id The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
- performance_
insights_ intretention_ period The amount of time, in days, to retain Performance Insights data.
- port int
The port number on which the instances in the DB cluster accept connections. Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.
- preferred_
backup_ strwindow The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
- preferred_
maintenance_ strwindow The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). 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.
- read_
endpoint DBClusterRead Endpoint - replication_
source_ stridentifier The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.
- scaling_
configuration DBClusterScaling Configuration The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster.
- serverless_
v2_ DBClusterscaling_ configuration Serverless V2Scaling Configuration Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
- storage_
type str Specifies the storage type to be associated with the DB cluster.
- Sequence[DBCluster
Tag] An array of key-value pairs to apply to this resource.
- vpc_
security_ Sequence[str]group_ ids A list of EC2 VPC security groups to associate with this DB cluster.
- allocated
Storage Number The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
- associated
Roles List<Property Map> 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 AWS services on your behalf.
- auto
Minor BooleanVersion Upgrade A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.
- backtrack
Window Number The target backtrack window, in seconds. To disable backtracking, set this value to 0.
- backup
Retention NumberPeriod The number of days for which automated backups are retained.
- 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.
- d
BCluster StringArn The Amazon Resource Name (ARN) for the DB cluster.
- d
BCluster StringInstance Class The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.
- d
BCluster StringParameter Group Name The name of the DB cluster parameter group to associate with this DB cluster.
- d
BCluster StringResource Id The AWS Region-unique, immutable identifier for the DB cluster.
- deletion
Protection Boolean 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.
- domain String
The Active Directory directory ID to create the DB cluster in.
- domain
IAMRole StringName Specify the name of the IAM role to be used when making API calls to the Directory Service.
- enable
Cloudwatch List<String>Logs Exports 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.
- enable
Http BooleanEndpoint A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.
- enable
IAMDatabase BooleanAuthentication A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
- endpoint Property Map
- engine String
The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql
- engine
Version String The version number of the database engine to use.
- global
Cluster StringIdentifier 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.
- iops Number
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
- manage
Master BooleanUser Password A value that indicates whether to manage the master user password with AWS Secrets Manager.
- master
User Property MapSecret Contains the secret managed by RDS in AWS Secrets Manager for the master user password.
- master
Username String The name of the master user for the DB cluster. You must specify MasterUsername, unless you specify SnapshotIdentifier. In that case, don't specify MasterUsername.
- monitoring
Interval Number 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. The default is 0.
- monitoring
Role StringArn The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
- network
Type String The network type of the DB cluster.
- performance
Insights BooleanEnabled A value that indicates whether to turn on Performance Insights for the DB cluster.
- performance
Insights StringKms Key Id The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
- performance
Insights NumberRetention Period The amount of time, in days, to retain Performance Insights data.
- port Number
The port number on which the instances in the DB cluster accept connections. Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.
- preferred
Backup StringWindow The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
- preferred
Maintenance StringWindow The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). 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.
- read
Endpoint Property Map - replication
Source StringIdentifier The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.
- scaling
Configuration Property Map The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster.
- serverless
V2Scaling Property MapConfiguration Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
- storage
Type String Specifies the storage type to be associated with the DB cluster.
- List<Property Map>
An array of key-value pairs to apply to this resource.
- vpc
Security List<String>Group Ids A list of EC2 VPC security groups to associate with this DB cluster.
Supporting Types
DBClusterEndpoint
DBClusterMasterUserSecret
- kms_
key_ strid The AWS KMS key identifier that is used to encrypt the secret.
- secret_
arn str The Amazon Resource Name (ARN) of the secret.
DBClusterReadEndpoint
- Address string
The reader endpoint for the DB cluster.
- Address string
The reader endpoint for the DB cluster.
- address String
The reader endpoint for the DB cluster.
- address string
The reader endpoint for the DB cluster.
- address str
The reader endpoint for the DB cluster.
- address String
The reader endpoint for the DB cluster.
DBClusterRole
- Role
Arn string The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
- Feature
Name string The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon RDS API Reference.
- Role
Arn string The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
- Feature
Name string The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon RDS API Reference.
- role
Arn String The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
- feature
Name String The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon RDS API Reference.
- role
Arn string The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
- feature
Name string The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see 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. For the list of supported feature names, see DBEngineVersion in the Amazon RDS API Reference.
- role
Arn String The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
- feature
Name String The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon RDS API Reference.
DBClusterScalingConfiguration
- Auto
Pause bool A value that 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).
- 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 intTimeout 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.
- Seconds
Until intAuto Pause The time, in seconds, before an Aurora DB cluster in serverless mode is paused.
- Timeout
Action 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.
For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.
- Auto
Pause bool A value that 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).
- 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 intTimeout 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.
- Seconds
Until intAuto Pause The time, in seconds, before an Aurora DB cluster in serverless mode is paused.
- Timeout
Action 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.
For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.
- auto
Pause Boolean A value that 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).
- max
Capacity 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.
- min
Capacity 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.
- seconds
Before IntegerTimeout 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.
- seconds
Until IntegerAuto Pause The time, in seconds, before an Aurora DB cluster in serverless mode is paused.
- timeout
Action 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.
For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.
- auto
Pause boolean A value that 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).
- max
Capacity 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.
- min
Capacity 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.
- seconds
Before numberTimeout 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.
- seconds
Until numberAuto Pause The time, in seconds, before an Aurora DB cluster in serverless mode is paused.
- timeout
Action 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.
For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.
- auto_
pause bool A value that 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).
- 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_ inttimeout 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.
- seconds_
until_ intauto_ pause The time, in seconds, before an Aurora DB cluster in serverless mode is paused.
- 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.
For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.
- auto
Pause Boolean A value that 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).
- max
Capacity 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.
- min
Capacity 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.
- seconds
Before NumberTimeout 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.
- seconds
Until NumberAuto Pause The time, in seconds, before an Aurora DB cluster in serverless mode is paused.
- timeout
Action 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.
For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.
DBClusterServerlessV2ScalingConfiguration
- Max
Capacity 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.
- Min
Capacity 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.
- Max
Capacity 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.
- Min
Capacity 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.
- max
Capacity 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.
- min
Capacity 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.
- max
Capacity 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.
- min
Capacity 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.
- 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.
- max
Capacity 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.
- min
Capacity 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.
DBClusterTag
- Key string
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Value string
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Key string
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Value string
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key String
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value String
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key string
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value string
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key str
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value str
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key String
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value String
The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0