Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The rdsDBClusters resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.AwsConnector/rdsDBClusters resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.AwsConnector/rdsDBClusters@2024-12-01' = {
location: 'string'
name: 'string'
properties: {
arn: 'string'
awsAccountId: 'string'
awsProperties: {
allocatedStorage: int
associatedRoles: [
{
featureName: 'string'
roleArn: 'string'
}
]
autoMinorVersionUpgrade: bool
availabilityZones: [
'string'
]
backtrackWindow: int
backupRetentionPeriod: int
copyTagsToSnapshot: bool
databaseName: 'string'
dbClusterArn: 'string'
dbClusterIdentifier: 'string'
dbClusterInstanceClass: 'string'
dbClusterParameterGroupName: 'string'
dbClusterResourceId: 'string'
dbInstanceParameterGroupName: 'string'
dbSubnetGroupName: 'string'
dbSystemId: 'string'
deletionProtection: bool
domain: 'string'
domainIAMRoleName: 'string'
enableCloudwatchLogsExports: [
'string'
]
enableGlobalWriteForwarding: bool
enableHttpEndpoint: bool
enableIAMDatabaseAuthentication: bool
endpoint: {
address: 'string'
port: 'string'
}
engine: 'string'
engineMode: 'string'
engineVersion: 'string'
globalClusterIdentifier: 'string'
iops: int
kmsKeyId: 'string'
manageMasterUserPassword: bool
masterUsername: 'string'
masterUserPassword: 'string'
masterUserSecret: {
kmsKeyId: 'string'
secretArn: 'string'
}
monitoringInterval: int
monitoringRoleArn: 'string'
networkType: 'string'
performanceInsightsEnabled: bool
performanceInsightsKmsKeyId: 'string'
performanceInsightsRetentionPeriod: int
port: int
preferredBackupWindow: 'string'
preferredMaintenanceWindow: 'string'
publiclyAccessible: bool
readEndpoint: {
address: 'string'
}
replicationSourceIdentifier: 'string'
restoreToTime: 'string'
restoreType: 'string'
scalingConfiguration: {
autoPause: bool
maxCapacity: int
minCapacity: int
secondsBeforeTimeout: int
secondsUntilAutoPause: int
timeoutAction: 'string'
}
serverlessV2ScalingConfiguration: {
maxCapacity: int
minCapacity: int
}
snapshotIdentifier: 'string'
sourceDBClusterIdentifier: 'string'
sourceRegion: 'string'
storageEncrypted: bool
storageThroughput: int
storageType: 'string'
tags: [
{
key: 'string'
value: 'string'
}
]
useLatestRestorableTime: bool
vpcSecurityGroupIds: [
'string'
]
}
awsRegion: 'string'
awsSourceSchema: 'string'
awsTags: {
{customized property}: 'string'
}
publicCloudConnectorsResourceId: 'string'
publicCloudResourceName: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.AwsConnector/rdsDBClusters
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#]) (required) |
| properties | The resource-specific properties for this resource. | RdsDBClusterProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
AwsRdsDBClusterProperties
| Name | Description | Value |
|---|---|---|
| allocatedStorage | The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster. | int |
| associatedRoles | 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. | DBClusterRole[] |
| autoMinorVersionUpgrade | 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. | bool |
| availabilityZones | A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide. | string[] |
| backtrackWindow | The target backtrack window, in seconds. To disable backtracking, set this value to 0. | int |
| backupRetentionPeriod | The number of days for which automated backups are retained. | int |
| copyTagsToSnapshot | 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. | bool |
| databaseName | The name of your database. If you don't provide a name, then Amazon RDS won't create a database in this DB cluster. For naming constraints, see Naming Constraints in the Amazon RDS User Guide. | string |
| dbClusterArn | The Amazon Resource Name (ARN) for the DB cluster. | string |
| dbClusterIdentifier | The DB cluster identifier. This parameter is stored as a lowercase string. | string |
| dbClusterInstanceClass | The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. | string |
| dbClusterParameterGroupName | The name of the DB cluster parameter group to associate with this DB cluster. | string |
| dbClusterResourceId | The AWS Region-unique, immutable identifier for the DB cluster. | string |
| dbInstanceParameterGroupName | The name of the DB parameter group to apply to all instances of the DB cluster. | string |
| dbSubnetGroupName | A DB subnet group that you want to associate with this DB cluster. | string |
| dbSystemId | Reserved for future use. | string |
| deletionProtection | 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. | bool |
| domain | The Active Directory directory ID to create the DB cluster in. | string |
| domainIAMRoleName | Specify the name of the IAM role to be used when making API calls to the Directory Service. | string |
| enableCloudwatchLogsExports | 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. | string[] |
| enableGlobalWriteForwarding | Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database. | bool |
| enableHttpEndpoint | A value that indicates whether to enable the HTTP endpoint for DB cluster. By default, the HTTP endpoint is disabled. | bool |
| enableIAMDatabaseAuthentication | A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. | bool |
| endpoint | Property endpoint | EndpointAutoGenerated |
| engine | 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 | string |
| engineMode | The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster. | string |
| engineVersion | The version number of the database engine to use. | string |
| globalClusterIdentifier | 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. | string |
| iops | The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. | int |
| kmsKeyId | The Amazon Resource Name (ARN) of the AWS Key Management Service master key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If you enable the StorageEncrypted property but don't specify this property, the default master key is used. If you specify this property, you must set the StorageEncrypted property to true. | string |
| manageMasterUserPassword | A value that indicates whether to manage the master user password with AWS Secrets Manager. | bool |
| masterUsername | 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. | string |
| masterUserPassword | The master password for the DB instance. | string |
| masterUserSecret | Contains the secret managed by RDS in AWS Secrets Manager for the master user password. | MasterUserSecret |
| monitoringInterval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0. | int |
| monitoringRoleArn | The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. | string |
| networkType | The network type of the DB cluster. | string |
| performanceInsightsEnabled | A value that indicates whether to turn on Performance Insights for the DB cluster. | bool |
| performanceInsightsKmsKeyId | The Amazon Web Services KMS key identifier for encryption of Performance Insights data. | string |
| performanceInsightsRetentionPeriod | The amount of time, in days, to retain Performance Insights data. | int |
| port | 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. | int |
| preferredBackupWindow | 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. | string |
| preferredMaintenanceWindow | 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. | string |
| publiclyAccessible | A value that indicates whether the DB cluster is publicly accessible. | bool |
| readEndpoint | Property readEndpoint | ReadEndpoint |
| replicationSourceIdentifier | The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica. | string |
| restoreToTime | The date and time to restore the DB cluster to. Value must be a time in Universal Coordinated Time (UTC) format. An example: 2015-03-07T23:45:00Z | string |
| restoreType | The type of restore to be performed. You can specify one of the following values:full-copy - The new DB cluster is restored as a full copy of the source DB cluster.copy-on-write - The new DB cluster is restored as a clone of the source DB cluster. | string |
| scalingConfiguration | The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster. The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster. | ScalingConfiguration |
| serverlessV2ScalingConfiguration | Contains the scaling configuration of an Aurora Serverless v2 DB cluster. Contains the scaling configuration of an Aurora Serverless v2 DB cluster. | ServerlessV2ScalingConfiguration |
| snapshotIdentifier | The identifier for the DB snapshot or DB cluster snapshot to restore from.You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.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 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, the DB cluster is restored from the specified SnapshotIdentifier property, and the original DB cluster is deleted. | string |
| sourceDBClusterIdentifier | The identifier of the source DB cluster from which to restore. | string |
| sourceRegion | The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1. | string |
| storageEncrypted | Indicates whether the DB instance is encrypted.If you specify the DBClusterIdentifier, SnapshotIdentifier, or SourceDBInstanceIdentifier property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance. | bool |
| storageThroughput | Specifies the storage throughput value for the DB cluster. This setting applies only to the gp3 storage type. | int |
| storageType | Specifies the storage type to be associated with the DB cluster. | string |
| tags | An array of key-value pairs to apply to this resource. | TagAutoGenerated45[] |
| useLatestRestorableTime | A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster is not restored to the latest restorable backup time. | bool |
| vpcSecurityGroupIds | A list of EC2 VPC security groups to associate with this DB cluster. | string[] |
DBClusterRole
| Name | Description | Value |
|---|---|---|
| featureName | 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. | string |
| roleArn | The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster. | string |
EndpointAutoGenerated
| Name | Description | Value |
|---|---|---|
| address | The connection endpoint for the DB cluster. | string |
| port | The port number that will accept connections on this DB cluster. | string |
MasterUserSecret
| Name | Description | Value |
|---|---|---|
| kmsKeyId | The AWS KMS key identifier that is used to encrypt the secret. | string |
| secretArn | The Amazon Resource Name (ARN) of the secret. | string |
RdsDBClusterProperties
| Name | Description | Value |
|---|---|---|
| arn | Amazon Resource Name (ARN) | string |
| awsAccountId | AWS Account ID | string |
| awsProperties | AWS Properties | AwsRdsDBClusterProperties |
| awsRegion | AWS Region | string |
| awsSourceSchema | AWS Source Schema | string |
| awsTags | AWS Tags | RdsDBClusterPropertiesAwsTags |
| publicCloudConnectorsResourceId | Public Cloud Connectors Resource ID | string |
| publicCloudResourceName | Public Cloud Resource Name | string |
RdsDBClusterPropertiesAwsTags
| Name | Description | Value |
|---|
ReadEndpoint
| Name | Description | Value |
|---|---|---|
| address | The reader endpoint for the DB cluster. | string |
ScalingConfiguration
| Name | Description | Value |
|---|---|---|
| autoPause | 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). | bool |
| maxCapacity | 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. | int |
| minCapacity | 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. | int |
| secondsBeforeTimeout | 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. | int |
| secondsUntilAutoPause | The time, in seconds, before an Aurora DB cluster in serverless mode is paused. | int |
| timeoutAction | 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. | string |
ServerlessV2ScalingConfiguration
| Name | Description | Value |
|---|---|---|
| maxCapacity | 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. | int |
| minCapacity | 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. | int |
TagAutoGenerated45
| Name | Description | Value |
|---|---|---|
| key | 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 -. | string |
| value | 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 -. | string |
TrackedResourceTags
| Name | Description | Value |
|---|
ARM template resource definition
The rdsDBClusters resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.AwsConnector/rdsDBClusters resource, add the following JSON to your template.
{
"type": "Microsoft.AwsConnector/rdsDBClusters",
"apiVersion": "2024-12-01",
"name": "string",
"location": "string",
"properties": {
"arn": "string",
"awsAccountId": "string",
"awsProperties": {
"allocatedStorage": "int",
"associatedRoles": [
{
"featureName": "string",
"roleArn": "string"
}
],
"autoMinorVersionUpgrade": "bool",
"availabilityZones": [ "string" ],
"backtrackWindow": "int",
"backupRetentionPeriod": "int",
"copyTagsToSnapshot": "bool",
"databaseName": "string",
"dbClusterArn": "string",
"dbClusterIdentifier": "string",
"dbClusterInstanceClass": "string",
"dbClusterParameterGroupName": "string",
"dbClusterResourceId": "string",
"dbInstanceParameterGroupName": "string",
"dbSubnetGroupName": "string",
"dbSystemId": "string",
"deletionProtection": "bool",
"domain": "string",
"domainIAMRoleName": "string",
"enableCloudwatchLogsExports": [ "string" ],
"enableGlobalWriteForwarding": "bool",
"enableHttpEndpoint": "bool",
"enableIAMDatabaseAuthentication": "bool",
"endpoint": {
"address": "string",
"port": "string"
},
"engine": "string",
"engineMode": "string",
"engineVersion": "string",
"globalClusterIdentifier": "string",
"iops": "int",
"kmsKeyId": "string",
"manageMasterUserPassword": "bool",
"masterUsername": "string",
"masterUserPassword": "string",
"masterUserSecret": {
"kmsKeyId": "string",
"secretArn": "string"
},
"monitoringInterval": "int",
"monitoringRoleArn": "string",
"networkType": "string",
"performanceInsightsEnabled": "bool",
"performanceInsightsKmsKeyId": "string",
"performanceInsightsRetentionPeriod": "int",
"port": "int",
"preferredBackupWindow": "string",
"preferredMaintenanceWindow": "string",
"publiclyAccessible": "bool",
"readEndpoint": {
"address": "string"
},
"replicationSourceIdentifier": "string",
"restoreToTime": "string",
"restoreType": "string",
"scalingConfiguration": {
"autoPause": "bool",
"maxCapacity": "int",
"minCapacity": "int",
"secondsBeforeTimeout": "int",
"secondsUntilAutoPause": "int",
"timeoutAction": "string"
},
"serverlessV2ScalingConfiguration": {
"maxCapacity": "int",
"minCapacity": "int"
},
"snapshotIdentifier": "string",
"sourceDBClusterIdentifier": "string",
"sourceRegion": "string",
"storageEncrypted": "bool",
"storageThroughput": "int",
"storageType": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"useLatestRestorableTime": "bool",
"vpcSecurityGroupIds": [ "string" ]
},
"awsRegion": "string",
"awsSourceSchema": "string",
"awsTags": {
"{customized property}": "string"
},
"publicCloudConnectorsResourceId": "string",
"publicCloudResourceName": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.AwsConnector/rdsDBClusters
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-12-01' |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#]) (required) |
| properties | The resource-specific properties for this resource. | RdsDBClusterProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.AwsConnector/rdsDBClusters' |
AwsRdsDBClusterProperties
| Name | Description | Value |
|---|---|---|
| allocatedStorage | The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster. | int |
| associatedRoles | 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. | DBClusterRole[] |
| autoMinorVersionUpgrade | 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. | bool |
| availabilityZones | A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide. | string[] |
| backtrackWindow | The target backtrack window, in seconds. To disable backtracking, set this value to 0. | int |
| backupRetentionPeriod | The number of days for which automated backups are retained. | int |
| copyTagsToSnapshot | 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. | bool |
| databaseName | The name of your database. If you don't provide a name, then Amazon RDS won't create a database in this DB cluster. For naming constraints, see Naming Constraints in the Amazon RDS User Guide. | string |
| dbClusterArn | The Amazon Resource Name (ARN) for the DB cluster. | string |
| dbClusterIdentifier | The DB cluster identifier. This parameter is stored as a lowercase string. | string |
| dbClusterInstanceClass | The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. | string |
| dbClusterParameterGroupName | The name of the DB cluster parameter group to associate with this DB cluster. | string |
| dbClusterResourceId | The AWS Region-unique, immutable identifier for the DB cluster. | string |
| dbInstanceParameterGroupName | The name of the DB parameter group to apply to all instances of the DB cluster. | string |
| dbSubnetGroupName | A DB subnet group that you want to associate with this DB cluster. | string |
| dbSystemId | Reserved for future use. | string |
| deletionProtection | 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. | bool |
| domain | The Active Directory directory ID to create the DB cluster in. | string |
| domainIAMRoleName | Specify the name of the IAM role to be used when making API calls to the Directory Service. | string |
| enableCloudwatchLogsExports | 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. | string[] |
| enableGlobalWriteForwarding | Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database. | bool |
| enableHttpEndpoint | A value that indicates whether to enable the HTTP endpoint for DB cluster. By default, the HTTP endpoint is disabled. | bool |
| enableIAMDatabaseAuthentication | A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. | bool |
| endpoint | Property endpoint | EndpointAutoGenerated |
| engine | 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 | string |
| engineMode | The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster. | string |
| engineVersion | The version number of the database engine to use. | string |
| globalClusterIdentifier | 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. | string |
| iops | The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. | int |
| kmsKeyId | The Amazon Resource Name (ARN) of the AWS Key Management Service master key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If you enable the StorageEncrypted property but don't specify this property, the default master key is used. If you specify this property, you must set the StorageEncrypted property to true. | string |
| manageMasterUserPassword | A value that indicates whether to manage the master user password with AWS Secrets Manager. | bool |
| masterUsername | 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. | string |
| masterUserPassword | The master password for the DB instance. | string |
| masterUserSecret | Contains the secret managed by RDS in AWS Secrets Manager for the master user password. | MasterUserSecret |
| monitoringInterval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0. | int |
| monitoringRoleArn | The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. | string |
| networkType | The network type of the DB cluster. | string |
| performanceInsightsEnabled | A value that indicates whether to turn on Performance Insights for the DB cluster. | bool |
| performanceInsightsKmsKeyId | The Amazon Web Services KMS key identifier for encryption of Performance Insights data. | string |
| performanceInsightsRetentionPeriod | The amount of time, in days, to retain Performance Insights data. | int |
| port | 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. | int |
| preferredBackupWindow | 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. | string |
| preferredMaintenanceWindow | 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. | string |
| publiclyAccessible | A value that indicates whether the DB cluster is publicly accessible. | bool |
| readEndpoint | Property readEndpoint | ReadEndpoint |
| replicationSourceIdentifier | The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica. | string |
| restoreToTime | The date and time to restore the DB cluster to. Value must be a time in Universal Coordinated Time (UTC) format. An example: 2015-03-07T23:45:00Z | string |
| restoreType | The type of restore to be performed. You can specify one of the following values:full-copy - The new DB cluster is restored as a full copy of the source DB cluster.copy-on-write - The new DB cluster is restored as a clone of the source DB cluster. | string |
| scalingConfiguration | The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster. The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster. | ScalingConfiguration |
| serverlessV2ScalingConfiguration | Contains the scaling configuration of an Aurora Serverless v2 DB cluster. Contains the scaling configuration of an Aurora Serverless v2 DB cluster. | ServerlessV2ScalingConfiguration |
| snapshotIdentifier | The identifier for the DB snapshot or DB cluster snapshot to restore from.You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.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 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, the DB cluster is restored from the specified SnapshotIdentifier property, and the original DB cluster is deleted. | string |
| sourceDBClusterIdentifier | The identifier of the source DB cluster from which to restore. | string |
| sourceRegion | The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1. | string |
| storageEncrypted | Indicates whether the DB instance is encrypted.If you specify the DBClusterIdentifier, SnapshotIdentifier, or SourceDBInstanceIdentifier property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance. | bool |
| storageThroughput | Specifies the storage throughput value for the DB cluster. This setting applies only to the gp3 storage type. | int |
| storageType | Specifies the storage type to be associated with the DB cluster. | string |
| tags | An array of key-value pairs to apply to this resource. | TagAutoGenerated45[] |
| useLatestRestorableTime | A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster is not restored to the latest restorable backup time. | bool |
| vpcSecurityGroupIds | A list of EC2 VPC security groups to associate with this DB cluster. | string[] |
DBClusterRole
| Name | Description | Value |
|---|---|---|
| featureName | 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. | string |
| roleArn | The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster. | string |
EndpointAutoGenerated
| Name | Description | Value |
|---|---|---|
| address | The connection endpoint for the DB cluster. | string |
| port | The port number that will accept connections on this DB cluster. | string |
MasterUserSecret
| Name | Description | Value |
|---|---|---|
| kmsKeyId | The AWS KMS key identifier that is used to encrypt the secret. | string |
| secretArn | The Amazon Resource Name (ARN) of the secret. | string |
RdsDBClusterProperties
| Name | Description | Value |
|---|---|---|
| arn | Amazon Resource Name (ARN) | string |
| awsAccountId | AWS Account ID | string |
| awsProperties | AWS Properties | AwsRdsDBClusterProperties |
| awsRegion | AWS Region | string |
| awsSourceSchema | AWS Source Schema | string |
| awsTags | AWS Tags | RdsDBClusterPropertiesAwsTags |
| publicCloudConnectorsResourceId | Public Cloud Connectors Resource ID | string |
| publicCloudResourceName | Public Cloud Resource Name | string |
RdsDBClusterPropertiesAwsTags
| Name | Description | Value |
|---|
ReadEndpoint
| Name | Description | Value |
|---|---|---|
| address | The reader endpoint for the DB cluster. | string |
ScalingConfiguration
| Name | Description | Value |
|---|---|---|
| autoPause | 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). | bool |
| maxCapacity | 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. | int |
| minCapacity | 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. | int |
| secondsBeforeTimeout | 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. | int |
| secondsUntilAutoPause | The time, in seconds, before an Aurora DB cluster in serverless mode is paused. | int |
| timeoutAction | 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. | string |
ServerlessV2ScalingConfiguration
| Name | Description | Value |
|---|---|---|
| maxCapacity | 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. | int |
| minCapacity | 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. | int |
TagAutoGenerated45
| Name | Description | Value |
|---|---|---|
| key | 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 -. | string |
| value | 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 -. | string |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Terraform (AzAPI provider) resource definition
The rdsDBClusters resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.AwsConnector/rdsDBClusters resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.AwsConnector/rdsDBClusters@2024-12-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
arn = "string"
awsAccountId = "string"
awsProperties = {
allocatedStorage = int
associatedRoles = [
{
featureName = "string"
roleArn = "string"
}
]
autoMinorVersionUpgrade = bool
availabilityZones = [
"string"
]
backtrackWindow = int
backupRetentionPeriod = int
copyTagsToSnapshot = bool
databaseName = "string"
dbClusterArn = "string"
dbClusterIdentifier = "string"
dbClusterInstanceClass = "string"
dbClusterParameterGroupName = "string"
dbClusterResourceId = "string"
dbInstanceParameterGroupName = "string"
dbSubnetGroupName = "string"
dbSystemId = "string"
deletionProtection = bool
domain = "string"
domainIAMRoleName = "string"
enableCloudwatchLogsExports = [
"string"
]
enableGlobalWriteForwarding = bool
enableHttpEndpoint = bool
enableIAMDatabaseAuthentication = bool
endpoint = {
address = "string"
port = "string"
}
engine = "string"
engineMode = "string"
engineVersion = "string"
globalClusterIdentifier = "string"
iops = int
kmsKeyId = "string"
manageMasterUserPassword = bool
masterUsername = "string"
masterUserPassword = "string"
masterUserSecret = {
kmsKeyId = "string"
secretArn = "string"
}
monitoringInterval = int
monitoringRoleArn = "string"
networkType = "string"
performanceInsightsEnabled = bool
performanceInsightsKmsKeyId = "string"
performanceInsightsRetentionPeriod = int
port = int
preferredBackupWindow = "string"
preferredMaintenanceWindow = "string"
publiclyAccessible = bool
readEndpoint = {
address = "string"
}
replicationSourceIdentifier = "string"
restoreToTime = "string"
restoreType = "string"
scalingConfiguration = {
autoPause = bool
maxCapacity = int
minCapacity = int
secondsBeforeTimeout = int
secondsUntilAutoPause = int
timeoutAction = "string"
}
serverlessV2ScalingConfiguration = {
maxCapacity = int
minCapacity = int
}
snapshotIdentifier = "string"
sourceDBClusterIdentifier = "string"
sourceRegion = "string"
storageEncrypted = bool
storageThroughput = int
storageType = "string"
tags = [
{
key = "string"
value = "string"
}
]
useLatestRestorableTime = bool
vpcSecurityGroupIds = [
"string"
]
}
awsRegion = "string"
awsSourceSchema = "string"
awsTags = {
{customized property} = "string"
}
publicCloudConnectorsResourceId = "string"
publicCloudResourceName = "string"
}
}
}
Property Values
Microsoft.AwsConnector/rdsDBClusters
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^(?=.{0,259}[^\s.]$)(?!.*[<>%&\?/#]) (required) |
| properties | The resource-specific properties for this resource. | RdsDBClusterProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.AwsConnector/rdsDBClusters@2024-12-01" |
AwsRdsDBClusterProperties
| Name | Description | Value |
|---|---|---|
| allocatedStorage | The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster. | int |
| associatedRoles | 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. | DBClusterRole[] |
| autoMinorVersionUpgrade | 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. | bool |
| availabilityZones | A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide. | string[] |
| backtrackWindow | The target backtrack window, in seconds. To disable backtracking, set this value to 0. | int |
| backupRetentionPeriod | The number of days for which automated backups are retained. | int |
| copyTagsToSnapshot | 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. | bool |
| databaseName | The name of your database. If you don't provide a name, then Amazon RDS won't create a database in this DB cluster. For naming constraints, see Naming Constraints in the Amazon RDS User Guide. | string |
| dbClusterArn | The Amazon Resource Name (ARN) for the DB cluster. | string |
| dbClusterIdentifier | The DB cluster identifier. This parameter is stored as a lowercase string. | string |
| dbClusterInstanceClass | The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. | string |
| dbClusterParameterGroupName | The name of the DB cluster parameter group to associate with this DB cluster. | string |
| dbClusterResourceId | The AWS Region-unique, immutable identifier for the DB cluster. | string |
| dbInstanceParameterGroupName | The name of the DB parameter group to apply to all instances of the DB cluster. | string |
| dbSubnetGroupName | A DB subnet group that you want to associate with this DB cluster. | string |
| dbSystemId | Reserved for future use. | string |
| deletionProtection | 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. | bool |
| domain | The Active Directory directory ID to create the DB cluster in. | string |
| domainIAMRoleName | Specify the name of the IAM role to be used when making API calls to the Directory Service. | string |
| enableCloudwatchLogsExports | 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. | string[] |
| enableGlobalWriteForwarding | Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database. | bool |
| enableHttpEndpoint | A value that indicates whether to enable the HTTP endpoint for DB cluster. By default, the HTTP endpoint is disabled. | bool |
| enableIAMDatabaseAuthentication | A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. | bool |
| endpoint | Property endpoint | EndpointAutoGenerated |
| engine | 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 | string |
| engineMode | The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster. | string |
| engineVersion | The version number of the database engine to use. | string |
| globalClusterIdentifier | 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. | string |
| iops | The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. | int |
| kmsKeyId | The Amazon Resource Name (ARN) of the AWS Key Management Service master key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If you enable the StorageEncrypted property but don't specify this property, the default master key is used. If you specify this property, you must set the StorageEncrypted property to true. | string |
| manageMasterUserPassword | A value that indicates whether to manage the master user password with AWS Secrets Manager. | bool |
| masterUsername | 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. | string |
| masterUserPassword | The master password for the DB instance. | string |
| masterUserSecret | Contains the secret managed by RDS in AWS Secrets Manager for the master user password. | MasterUserSecret |
| monitoringInterval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0. | int |
| monitoringRoleArn | The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. | string |
| networkType | The network type of the DB cluster. | string |
| performanceInsightsEnabled | A value that indicates whether to turn on Performance Insights for the DB cluster. | bool |
| performanceInsightsKmsKeyId | The Amazon Web Services KMS key identifier for encryption of Performance Insights data. | string |
| performanceInsightsRetentionPeriod | The amount of time, in days, to retain Performance Insights data. | int |
| port | 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. | int |
| preferredBackupWindow | 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. | string |
| preferredMaintenanceWindow | 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. | string |
| publiclyAccessible | A value that indicates whether the DB cluster is publicly accessible. | bool |
| readEndpoint | Property readEndpoint | ReadEndpoint |
| replicationSourceIdentifier | The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica. | string |
| restoreToTime | The date and time to restore the DB cluster to. Value must be a time in Universal Coordinated Time (UTC) format. An example: 2015-03-07T23:45:00Z | string |
| restoreType | The type of restore to be performed. You can specify one of the following values:full-copy - The new DB cluster is restored as a full copy of the source DB cluster.copy-on-write - The new DB cluster is restored as a clone of the source DB cluster. | string |
| scalingConfiguration | The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster. The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster. | ScalingConfiguration |
| serverlessV2ScalingConfiguration | Contains the scaling configuration of an Aurora Serverless v2 DB cluster. Contains the scaling configuration of an Aurora Serverless v2 DB cluster. | ServerlessV2ScalingConfiguration |
| snapshotIdentifier | The identifier for the DB snapshot or DB cluster snapshot to restore from.You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.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 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, the DB cluster is restored from the specified SnapshotIdentifier property, and the original DB cluster is deleted. | string |
| sourceDBClusterIdentifier | The identifier of the source DB cluster from which to restore. | string |
| sourceRegion | The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1. | string |
| storageEncrypted | Indicates whether the DB instance is encrypted.If you specify the DBClusterIdentifier, SnapshotIdentifier, or SourceDBInstanceIdentifier property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance. | bool |
| storageThroughput | Specifies the storage throughput value for the DB cluster. This setting applies only to the gp3 storage type. | int |
| storageType | Specifies the storage type to be associated with the DB cluster. | string |
| tags | An array of key-value pairs to apply to this resource. | TagAutoGenerated45[] |
| useLatestRestorableTime | A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster is not restored to the latest restorable backup time. | bool |
| vpcSecurityGroupIds | A list of EC2 VPC security groups to associate with this DB cluster. | string[] |
DBClusterRole
| Name | Description | Value |
|---|---|---|
| featureName | 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. | string |
| roleArn | The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster. | string |
EndpointAutoGenerated
| Name | Description | Value |
|---|---|---|
| address | The connection endpoint for the DB cluster. | string |
| port | The port number that will accept connections on this DB cluster. | string |
MasterUserSecret
| Name | Description | Value |
|---|---|---|
| kmsKeyId | The AWS KMS key identifier that is used to encrypt the secret. | string |
| secretArn | The Amazon Resource Name (ARN) of the secret. | string |
RdsDBClusterProperties
| Name | Description | Value |
|---|---|---|
| arn | Amazon Resource Name (ARN) | string |
| awsAccountId | AWS Account ID | string |
| awsProperties | AWS Properties | AwsRdsDBClusterProperties |
| awsRegion | AWS Region | string |
| awsSourceSchema | AWS Source Schema | string |
| awsTags | AWS Tags | RdsDBClusterPropertiesAwsTags |
| publicCloudConnectorsResourceId | Public Cloud Connectors Resource ID | string |
| publicCloudResourceName | Public Cloud Resource Name | string |
RdsDBClusterPropertiesAwsTags
| Name | Description | Value |
|---|
ReadEndpoint
| Name | Description | Value |
|---|---|---|
| address | The reader endpoint for the DB cluster. | string |
ScalingConfiguration
| Name | Description | Value |
|---|---|---|
| autoPause | 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). | bool |
| maxCapacity | 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. | int |
| minCapacity | 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. | int |
| secondsBeforeTimeout | 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. | int |
| secondsUntilAutoPause | The time, in seconds, before an Aurora DB cluster in serverless mode is paused. | int |
| timeoutAction | 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. | string |
ServerlessV2ScalingConfiguration
| Name | Description | Value |
|---|---|---|
| maxCapacity | 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. | int |
| minCapacity | 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. | int |
TagAutoGenerated45
| Name | Description | Value |
|---|---|---|
| key | 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 -. | string |
| value | 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 -. | string |
TrackedResourceTags
| Name | Description | Value |
|---|