Cluster

name string

The unique name of the resource.

args ClusterArgs

The arguments to resource properties.

opts CustomResourceOptions

Bag of options to control resource's behavior.

resource_name str

The unique name of the resource.

opts ResourceOptions

A bag of options that control this resource's behavior.

ctx Context

Context object for the current deployment.

name string

The unique name of the resource.

args ClusterArgs

The arguments to resource properties.

opts ResourceOption

Bag of options to control resource's behavior.

name string

The unique name of the resource.

args ClusterArgs

The arguments to resource properties.

opts CustomResourceOptions

Bag of options to control resource's behavior.

ApplyImmediately bool

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.

AvailabilityZones List<string>

A list of EC2 Availability Zones for the DB cluster storage where DB cluster instances can be created. RDS automatically assigns 3 AZs if less than 3 AZs are configured, which will show as a difference requiring resource recreation next provider update. It is recommended to specify 3 AZs or use the ignoreChanges argument if necessary.

BacktrackWindow int

The target backtrack window, in seconds. Only available for aurora engine currently. To disable backtracking, set this value to 0. Defaults to 0. Must be between 0 and 259200 (72 hours)

BackupRetentionPeriod int

The days to retain backups for. Default 1

ClusterIdentifier string

The cluster identifier. If omitted, this provider will assign a random, unique identifier.

ClusterIdentifierPrefix string

Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.

ClusterMembers List<string>

List of RDS Instances that are a part of this cluster

CopyTagsToSnapshot bool

Copy all Cluster tags to snapshots. Default is false.

DatabaseName string

Name for an automatically created database on cluster creation. There are different naming restrictions per database engine: RDS Naming Constraints

DbClusterParameterGroupName string

A cluster parameter group to associate with the cluster.

DbSubnetGroupName string

A DB subnet group to associate with this DB instance. NOTE: This must match the db_subnet_group_name specified on every aws.rds.ClusterInstance in the cluster.

DeletionProtection bool

If the DB instance should have deletion protection enabled. The database can’t be deleted when this value is set to true. The default is false.

EnableHttpEndpoint bool

Enable HTTP endpoint (data API). Only valid when engine_mode is set to serverless.

EnabledCloudwatchLogsExports List<string>

List of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, error, general, slowquery, postgresql (PostgreSQL).

Engine string

The name of the database engine to be used for this DB cluster. Defaults to aurora. Valid Values: aurora, aurora-mysql, aurora-postgresql

EngineMode string

The database engine mode. Valid values: global, multimaster, parallelquery, provisioned, serverless. Defaults to: provisioned. See the RDS User Guide for limitations when using serverless.

EngineVersion string

The database engine version. Updating this argument results in an outage. See the Aurora MySQL and Aurora Postgres documentation for your configured engine to determine this value. For example with Aurora MySQL 2, a potential value for this argument is 5.7.mysql_aurora.2.03.2.

FinalSnapshotIdentifier string

The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.

GlobalClusterIdentifier string

The global cluster identifier specified on aws.rds.GlobalCluster.

IamDatabaseAuthenticationEnabled bool

Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Please see AWS Documentation for availability and limitations.

IamRoles List<string>

A List of ARNs for the IAM roles to associate to the RDS Cluster.

KmsKeyId string

The ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.

MasterPassword string

Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the RDS Naming Constraints

MasterUsername string

Username for the master DB user. Please refer to the RDS Naming Constraints. This argument does not support in-place updates and cannot be changed during a restore from snapshot.

Port int

The port on which the DB accepts connections

PreferredBackupWindow string

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC. Default: A 30-minute window selected at random from an 8-hour block of time per region. e.g. 04:00-09:00

PreferredMaintenanceWindow string

The weekly time range during which system maintenance can occur, in (UTC) e.g. wed:04:00-wed:04:30

ReplicationSourceIdentifier string

ARN of a source DB cluster or DB instance if this DB cluster is to be created as a Read Replica.

S3Import ClusterS3ImportArgs

ScalingConfiguration ClusterScalingConfigurationArgs

Nested attribute with scaling properties. Only valid when engine_mode is set to serverless. More details below.

SkipFinalSnapshot bool

Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from final_snapshot_identifier. Default is false.

SnapshotIdentifier string

Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot.

SourceRegion string

The source region for an encrypted replica DB cluster.

StorageEncrypted bool

Specifies whether the DB cluster is encrypted. The default is false for provisioned engine_mode and true for serverless engine_mode.

Tags Dictionary<string, string>

A map of tags to assign to the DB cluster.

VpcSecurityGroupIds List<string>

List of VPC security groups to associate with the Cluster

ApplyImmediately bool

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.

AvailabilityZones []string

A list of EC2 Availability Zones for the DB cluster storage where DB cluster instances can be created. RDS automatically assigns 3 AZs if less than 3 AZs are configured, which will show as a difference requiring resource recreation next provider update. It is recommended to specify 3 AZs or use the ignoreChanges argument if necessary.

BacktrackWindow int

The target backtrack window, in seconds. Only available for aurora engine currently. To disable backtracking, set this value to 0. Defaults to 0. Must be between 0 and 259200 (72 hours)

BackupRetentionPeriod int

The days to retain backups for. Default 1

ClusterIdentifier string

The cluster identifier. If omitted, this provider will assign a random, unique identifier.

ClusterIdentifierPrefix string

Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.

ClusterMembers []string

List of RDS Instances that are a part of this cluster

CopyTagsToSnapshot bool

Copy all Cluster tags to snapshots. Default is false.

DatabaseName string

Name for an automatically created database on cluster creation. There are different naming restrictions per database engine: RDS Naming Constraints

DbClusterParameterGroupName string

A cluster parameter group to associate with the cluster.

DbSubnetGroupName string

A DB subnet group to associate with this DB instance. NOTE: This must match the db_subnet_group_name specified on every aws.rds.ClusterInstance in the cluster.

DeletionProtection bool

If the DB instance should have deletion protection enabled. The database can’t be deleted when this value is set to true. The default is false.

EnableHttpEndpoint bool

Enable HTTP endpoint (data API). Only valid when engine_mode is set to serverless.

EnabledCloudwatchLogsExports []string

List of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, error, general, slowquery, postgresql (PostgreSQL).

Engine string

The name of the database engine to be used for this DB cluster. Defaults to aurora. Valid Values: aurora, aurora-mysql, aurora-postgresql

EngineMode string

The database engine mode. Valid values: global, multimaster, parallelquery, provisioned, serverless. Defaults to: provisioned. See the RDS User Guide for limitations when using serverless.

EngineVersion string

The database engine version. Updating this argument results in an outage. See the Aurora MySQL and Aurora Postgres documentation for your configured engine to determine this value. For example with Aurora MySQL 2, a potential value for this argument is 5.7.mysql_aurora.2.03.2.

FinalSnapshotIdentifier string

The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.

GlobalClusterIdentifier string

The global cluster identifier specified on aws.rds.GlobalCluster.

IamDatabaseAuthenticationEnabled bool

Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Please see AWS Documentation for availability and limitations.

IamRoles []string

A List of ARNs for the IAM roles to associate to the RDS Cluster.

KmsKeyId string

The ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.

MasterPassword string

Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the RDS Naming Constraints

MasterUsername string

Username for the master DB user. Please refer to the RDS Naming Constraints. This argument does not support in-place updates and cannot be changed during a restore from snapshot.

Port int

The port on which the DB accepts connections

PreferredBackupWindow string

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC. Default: A 30-minute window selected at random from an 8-hour block of time per region. e.g. 04:00-09:00

PreferredMaintenanceWindow string

The weekly time range during which system maintenance can occur, in (UTC) e.g. wed:04:00-wed:04:30

ReplicationSourceIdentifier string

ARN of a source DB cluster or DB instance if this DB cluster is to be created as a Read Replica.

S3Import ClusterS3Import

ScalingConfiguration ClusterScalingConfiguration

Nested attribute with scaling properties. Only valid when engine_mode is set to serverless. More details below.

SkipFinalSnapshot bool

Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from final_snapshot_identifier. Default is false.

SnapshotIdentifier string

Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot.

SourceRegion string

The source region for an encrypted replica DB cluster.

StorageEncrypted bool

Specifies whether the DB cluster is encrypted. The default is false for provisioned engine_mode and true for serverless engine_mode.

Tags map[string]string

A map of tags to assign to the DB cluster.

VpcSecurityGroupIds []string

List of VPC security groups to associate with the Cluster

applyImmediately boolean

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.

availabilityZones string[]

A list of EC2 Availability Zones for the DB cluster storage where DB cluster instances can be created. RDS automatically assigns 3 AZs if less than 3 AZs are configured, which will show as a difference requiring resource recreation next provider update. It is recommended to specify 3 AZs or use the ignoreChanges argument if necessary.

backtrackWindow number

The target backtrack window, in seconds. Only available for aurora engine currently. To disable backtracking, set this value to 0. Defaults to 0. Must be between 0 and 259200 (72 hours)

backupRetentionPeriod number

The days to retain backups for. Default 1

clusterIdentifier string

The cluster identifier. If omitted, this provider will assign a random, unique identifier.

clusterIdentifierPrefix string

Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.

clusterMembers string[]

List of RDS Instances that are a part of this cluster

copyTagsToSnapshot boolean

Copy all Cluster tags to snapshots. Default is false.

databaseName string

Name for an automatically created database on cluster creation. There are different naming restrictions per database engine: RDS Naming Constraints

dbClusterParameterGroupName string

A cluster parameter group to associate with the cluster.

dbSubnetGroupName string

A DB subnet group to associate with this DB instance. NOTE: This must match the db_subnet_group_name specified on every aws.rds.ClusterInstance in the cluster.

deletionProtection boolean

If the DB instance should have deletion protection enabled. The database can’t be deleted when this value is set to true. The default is false.

enableHttpEndpoint boolean

Enable HTTP endpoint (data API). Only valid when engine_mode is set to serverless.

enabledCloudwatchLogsExports string[]

List of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, error, general, slowquery, postgresql (PostgreSQL).

engine EngineType

The name of the database engine to be used for this DB cluster. Defaults to aurora. Valid Values: aurora, aurora-mysql, aurora-postgresql

engineMode EngineMode

The database engine mode. Valid values: global, multimaster, parallelquery, provisioned, serverless. Defaults to: provisioned. See the RDS User Guide for limitations when using serverless.

engineVersion string

The database engine version. Updating this argument results in an outage. See the Aurora MySQL and Aurora Postgres documentation for your configured engine to determine this value. For example with Aurora MySQL 2, a potential value for this argument is 5.7.mysql_aurora.2.03.2.

finalSnapshotIdentifier string

The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.

globalClusterIdentifier string

The global cluster identifier specified on aws.rds.GlobalCluster.

iamDatabaseAuthenticationEnabled boolean

Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Please see AWS Documentation for availability and limitations.

iamRoles string[]

A List of ARNs for the IAM roles to associate to the RDS Cluster.

kmsKeyId string

The ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.

masterPassword string

Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the RDS Naming Constraints

masterUsername string

Username for the master DB user. Please refer to the RDS Naming Constraints. This argument does not support in-place updates and cannot be changed during a restore from snapshot.

port number

The port on which the DB accepts connections

preferredBackupWindow string

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC. Default: A 30-minute window selected at random from an 8-hour block of time per region. e.g. 04:00-09:00

preferredMaintenanceWindow string

The weekly time range during which system maintenance can occur, in (UTC) e.g. wed:04:00-wed:04:30

replicationSourceIdentifier string

ARN of a source DB cluster or DB instance if this DB cluster is to be created as a Read Replica.

s3Import ClusterS3Import

scalingConfiguration ClusterScalingConfiguration

Nested attribute with scaling properties. Only valid when engine_mode is set to serverless. More details below.

skipFinalSnapshot boolean

Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from final_snapshot_identifier. Default is false.

snapshotIdentifier string

Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot.

sourceRegion string

The source region for an encrypted replica DB cluster.

storageEncrypted boolean

Specifies whether the DB cluster is encrypted. The default is false for provisioned engine_mode and true for serverless engine_mode.

tags {[key: string]: string}

A map of tags to assign to the DB cluster.

vpcSecurityGroupIds string[]

List of VPC security groups to associate with the Cluster

apply_immediately bool

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.

availability_zones List[str]

A list of EC2 Availability Zones for the DB cluster storage where DB cluster instances can be created. RDS automatically assigns 3 AZs if less than 3 AZs are configured, which will show as a difference requiring resource recreation next provider update. It is recommended to specify 3 AZs or use the ignoreChanges argument if necessary.

backtrack_window float

The target backtrack window, in seconds. Only available for aurora engine currently. To disable backtracking, set this value to 0. Defaults to 0. Must be between 0 and 259200 (72 hours)

backup_retention_period float

The days to retain backups for. Default 1

cluster_identifier str

The cluster identifier. If omitted, this provider will assign a random, unique identifier.

cluster_identifier_prefix str

Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.

cluster_members List[str]

List of RDS Instances that are a part of this cluster

copy_tags_to_snapshot bool

Copy all Cluster tags to snapshots. Default is false.

database_name str

Name for an automatically created database on cluster creation. There are different naming restrictions per database engine: RDS Naming Constraints

db_cluster_parameter_group_name str

A cluster parameter group to associate with the cluster.

db_subnet_group_name str

A DB subnet group to associate with this DB instance. NOTE: This must match the db_subnet_group_name specified on every aws.rds.ClusterInstance in the cluster.

deletion_protection bool

If the DB instance should have deletion protection enabled. The database can’t be deleted when this value is set to true. The default is false.

enable_http_endpoint bool

Enable HTTP endpoint (data API). Only valid when engine_mode is set to serverless.

enabled_cloudwatch_logs_exports List[str]

List of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, error, general, slowquery, postgresql (PostgreSQL).

engine str

The name of the database engine to be used for this DB cluster. Defaults to aurora. Valid Values: aurora, aurora-mysql, aurora-postgresql

engine_mode str

The database engine mode. Valid values: global, multimaster, parallelquery, provisioned, serverless. Defaults to: provisioned. See the RDS User Guide for limitations when using serverless.

engine_version str

The database engine version. Updating this argument results in an outage. See the Aurora MySQL and Aurora Postgres documentation for your configured engine to determine this value. For example with Aurora MySQL 2, a potential value for this argument is 5.7.mysql_aurora.2.03.2.

final_snapshot_identifier str

The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.

global_cluster_identifier str

The global cluster identifier specified on aws.rds.GlobalCluster.

iam_database_authentication_enabled bool

Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Please see AWS Documentation for availability and limitations.

iam_roles List[str]

A List of ARNs for the IAM roles to associate to the RDS Cluster.

kms_key_id str

The ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.

master_password str

Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the RDS Naming Constraints

master_username str

Username for the master DB user. Please refer to the RDS Naming Constraints. This argument does not support in-place updates and cannot be changed during a restore from snapshot.

port float

The port on which the DB accepts connections

preferred_backup_window str

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC. Default: A 30-minute window selected at random from an 8-hour block of time per region. e.g. 04:00-09:00

preferred_maintenance_window str

The weekly time range during which system maintenance can occur, in (UTC) e.g. wed:04:00-wed:04:30

replication_source_identifier str

ARN of a source DB cluster or DB instance if this DB cluster is to be created as a Read Replica.

s3_import Dict[ClusterS3Import]

scaling_configuration Dict[ClusterScalingConfiguration]

Nested attribute with scaling properties. Only valid when engine_mode is set to serverless. More details below.

skip_final_snapshot bool

Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from final_snapshot_identifier. Default is false.

snapshot_identifier str

Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot.

source_region str

The source region for an encrypted replica DB cluster.

storage_encrypted bool

Specifies whether the DB cluster is encrypted. The default is false for provisioned engine_mode and true for serverless engine_mode.

tags Dict[str, str]

A map of tags to assign to the DB cluster.

vpc_security_group_ids List[str]

List of VPC security groups to associate with the Cluster

Arn string

Amazon Resource Name (ARN) of cluster

ClusterResourceId string

The RDS Cluster Resource ID

Endpoint string

The DNS address of the RDS instance

HostedZoneId string

The Route53 Hosted Zone ID of the endpoint

Id string

The provider-assigned unique ID for this managed resource.

ReaderEndpoint string

A read-only endpoint for the Aurora cluster, automatically load-balanced across replicas

Arn string

Amazon Resource Name (ARN) of cluster

ClusterResourceId string

The RDS Cluster Resource ID

Endpoint string

The DNS address of the RDS instance

HostedZoneId string

The Route53 Hosted Zone ID of the endpoint

Id string

The provider-assigned unique ID for this managed resource.

ReaderEndpoint string

A read-only endpoint for the Aurora cluster, automatically load-balanced across replicas

arn string

Amazon Resource Name (ARN) of cluster

clusterResourceId string

The RDS Cluster Resource ID

endpoint string

The DNS address of the RDS instance

hostedZoneId string

The Route53 Hosted Zone ID of the endpoint

id string

The provider-assigned unique ID for this managed resource.

readerEndpoint string

A read-only endpoint for the Aurora cluster, automatically load-balanced across replicas

arn str

Amazon Resource Name (ARN) of cluster

cluster_resource_id str

The RDS Cluster Resource ID

endpoint str

The DNS address of the RDS instance

hosted_zone_id str

The Route53 Hosted Zone ID of the endpoint

id str

The provider-assigned unique ID for this managed resource.

reader_endpoint str

A read-only endpoint for the Aurora cluster, automatically load-balanced across replicas

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

resource_name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

ApplyImmediately bool

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.

Arn string

Amazon Resource Name (ARN) of cluster

AvailabilityZones List<string>

A list of EC2 Availability Zones for the DB cluster storage where DB cluster instances can be created. RDS automatically assigns 3 AZs if less than 3 AZs are configured, which will show as a difference requiring resource recreation next provider update. It is recommended to specify 3 AZs or use the ignoreChanges argument if necessary.

BacktrackWindow int

The target backtrack window, in seconds. Only available for aurora engine currently. To disable backtracking, set this value to 0. Defaults to 0. Must be between 0 and 259200 (72 hours)

BackupRetentionPeriod int

The days to retain backups for. Default 1

ClusterIdentifier string

The cluster identifier. If omitted, this provider will assign a random, unique identifier.

ClusterIdentifierPrefix string

Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.

ClusterMembers List<string>

List of RDS Instances that are a part of this cluster

ClusterResourceId string

The RDS Cluster Resource ID

CopyTagsToSnapshot bool

Copy all Cluster tags to snapshots. Default is false.

DatabaseName string

Name for an automatically created database on cluster creation. There are different naming restrictions per database engine: RDS Naming Constraints

DbClusterParameterGroupName string

A cluster parameter group to associate with the cluster.

DbSubnetGroupName string

A DB subnet group to associate with this DB instance. NOTE: This must match the db_subnet_group_name specified on every aws.rds.ClusterInstance in the cluster.

DeletionProtection bool

If the DB instance should have deletion protection enabled. The database can’t be deleted when this value is set to true. The default is false.

EnableHttpEndpoint bool

Enable HTTP endpoint (data API). Only valid when engine_mode is set to serverless.

EnabledCloudwatchLogsExports List<string>

List of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, error, general, slowquery, postgresql (PostgreSQL).

Endpoint string

The DNS address of the RDS instance

Engine string

The name of the database engine to be used for this DB cluster. Defaults to aurora. Valid Values: aurora, aurora-mysql, aurora-postgresql

EngineMode string

The database engine mode. Valid values: global, multimaster, parallelquery, provisioned, serverless. Defaults to: provisioned. See the RDS User Guide for limitations when using serverless.

EngineVersion string

The database engine version. Updating this argument results in an outage. See the Aurora MySQL and Aurora Postgres documentation for your configured engine to determine this value. For example with Aurora MySQL 2, a potential value for this argument is 5.7.mysql_aurora.2.03.2.

FinalSnapshotIdentifier string

The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.

GlobalClusterIdentifier string

The global cluster identifier specified on aws.rds.GlobalCluster.

HostedZoneId string

The Route53 Hosted Zone ID of the endpoint

IamDatabaseAuthenticationEnabled bool

Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Please see AWS Documentation for availability and limitations.

IamRoles List<string>

A List of ARNs for the IAM roles to associate to the RDS Cluster.

KmsKeyId string

The ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.

MasterPassword string

Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the RDS Naming Constraints

MasterUsername string

Username for the master DB user. Please refer to the RDS Naming Constraints. This argument does not support in-place updates and cannot be changed during a restore from snapshot.

Port int

The port on which the DB accepts connections

PreferredBackupWindow string

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC. Default: A 30-minute window selected at random from an 8-hour block of time per region. e.g. 04:00-09:00

PreferredMaintenanceWindow string

The weekly time range during which system maintenance can occur, in (UTC) e.g. wed:04:00-wed:04:30

ReaderEndpoint string

A read-only endpoint for the Aurora cluster, automatically load-balanced across replicas

ReplicationSourceIdentifier string

ARN of a source DB cluster or DB instance if this DB cluster is to be created as a Read Replica.

S3Import ClusterS3ImportArgs

ScalingConfiguration ClusterScalingConfigurationArgs

Nested attribute with scaling properties. Only valid when engine_mode is set to serverless. More details below.

SkipFinalSnapshot bool

Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from final_snapshot_identifier. Default is false.

SnapshotIdentifier string

Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot.

SourceRegion string

The source region for an encrypted replica DB cluster.

StorageEncrypted bool

Specifies whether the DB cluster is encrypted. The default is false for provisioned engine_mode and true for serverless engine_mode.

Tags Dictionary<string, string>

A map of tags to assign to the DB cluster.

VpcSecurityGroupIds List<string>

List of VPC security groups to associate with the Cluster

ApplyImmediately bool

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.

Arn string

Amazon Resource Name (ARN) of cluster

AvailabilityZones []string

A list of EC2 Availability Zones for the DB cluster storage where DB cluster instances can be created. RDS automatically assigns 3 AZs if less than 3 AZs are configured, which will show as a difference requiring resource recreation next provider update. It is recommended to specify 3 AZs or use the ignoreChanges argument if necessary.

BacktrackWindow int

The target backtrack window, in seconds. Only available for aurora engine currently. To disable backtracking, set this value to 0. Defaults to 0. Must be between 0 and 259200 (72 hours)

BackupRetentionPeriod int

The days to retain backups for. Default 1

ClusterIdentifier string

The cluster identifier. If omitted, this provider will assign a random, unique identifier.

ClusterIdentifierPrefix string

Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.

ClusterMembers []string

List of RDS Instances that are a part of this cluster

ClusterResourceId string

The RDS Cluster Resource ID

CopyTagsToSnapshot bool

Copy all Cluster tags to snapshots. Default is false.

DatabaseName string

Name for an automatically created database on cluster creation. There are different naming restrictions per database engine: RDS Naming Constraints

DbClusterParameterGroupName string

A cluster parameter group to associate with the cluster.

DbSubnetGroupName string

A DB subnet group to associate with this DB instance. NOTE: This must match the db_subnet_group_name specified on every aws.rds.ClusterInstance in the cluster.

DeletionProtection bool

If the DB instance should have deletion protection enabled. The database can’t be deleted when this value is set to true. The default is false.

EnableHttpEndpoint bool

Enable HTTP endpoint (data API). Only valid when engine_mode is set to serverless.

EnabledCloudwatchLogsExports []string

List of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, error, general, slowquery, postgresql (PostgreSQL).

Endpoint string

The DNS address of the RDS instance

Engine string

The name of the database engine to be used for this DB cluster. Defaults to aurora. Valid Values: aurora, aurora-mysql, aurora-postgresql

EngineMode string

The database engine mode. Valid values: global, multimaster, parallelquery, provisioned, serverless. Defaults to: provisioned. See the RDS User Guide for limitations when using serverless.

EngineVersion string

The database engine version. Updating this argument results in an outage. See the Aurora MySQL and Aurora Postgres documentation for your configured engine to determine this value. For example with Aurora MySQL 2, a potential value for this argument is 5.7.mysql_aurora.2.03.2.

FinalSnapshotIdentifier string

The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.

GlobalClusterIdentifier string

The global cluster identifier specified on aws.rds.GlobalCluster.

HostedZoneId string

The Route53 Hosted Zone ID of the endpoint

IamDatabaseAuthenticationEnabled bool

Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Please see AWS Documentation for availability and limitations.

IamRoles []string

A List of ARNs for the IAM roles to associate to the RDS Cluster.

KmsKeyId string

The ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.

MasterPassword string

Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the RDS Naming Constraints

MasterUsername string

Username for the master DB user. Please refer to the RDS Naming Constraints. This argument does not support in-place updates and cannot be changed during a restore from snapshot.

Port int

The port on which the DB accepts connections

PreferredBackupWindow string

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC. Default: A 30-minute window selected at random from an 8-hour block of time per region. e.g. 04:00-09:00

PreferredMaintenanceWindow string

The weekly time range during which system maintenance can occur, in (UTC) e.g. wed:04:00-wed:04:30

ReaderEndpoint string

A read-only endpoint for the Aurora cluster, automatically load-balanced across replicas

ReplicationSourceIdentifier string

ARN of a source DB cluster or DB instance if this DB cluster is to be created as a Read Replica.

S3Import ClusterS3Import

ScalingConfiguration ClusterScalingConfiguration

Nested attribute with scaling properties. Only valid when engine_mode is set to serverless. More details below.

SkipFinalSnapshot bool

Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from final_snapshot_identifier. Default is false.

SnapshotIdentifier string

Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot.

SourceRegion string

The source region for an encrypted replica DB cluster.

StorageEncrypted bool

Specifies whether the DB cluster is encrypted. The default is false for provisioned engine_mode and true for serverless engine_mode.

Tags map[string]string

A map of tags to assign to the DB cluster.

VpcSecurityGroupIds []string

List of VPC security groups to associate with the Cluster

applyImmediately boolean

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.

arn string

Amazon Resource Name (ARN) of cluster

availabilityZones string[]

A list of EC2 Availability Zones for the DB cluster storage where DB cluster instances can be created. RDS automatically assigns 3 AZs if less than 3 AZs are configured, which will show as a difference requiring resource recreation next provider update. It is recommended to specify 3 AZs or use the ignoreChanges argument if necessary.

backtrackWindow number

The target backtrack window, in seconds. Only available for aurora engine currently. To disable backtracking, set this value to 0. Defaults to 0. Must be between 0 and 259200 (72 hours)

backupRetentionPeriod number

The days to retain backups for. Default 1

clusterIdentifier string

The cluster identifier. If omitted, this provider will assign a random, unique identifier.

clusterIdentifierPrefix string

Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.

clusterMembers string[]

List of RDS Instances that are a part of this cluster

clusterResourceId string

The RDS Cluster Resource ID

copyTagsToSnapshot boolean

Copy all Cluster tags to snapshots. Default is false.

databaseName string

Name for an automatically created database on cluster creation. There are different naming restrictions per database engine: RDS Naming Constraints

dbClusterParameterGroupName string

A cluster parameter group to associate with the cluster.

dbSubnetGroupName string

A DB subnet group to associate with this DB instance. NOTE: This must match the db_subnet_group_name specified on every aws.rds.ClusterInstance in the cluster.

deletionProtection boolean

If the DB instance should have deletion protection enabled. The database can’t be deleted when this value is set to true. The default is false.

enableHttpEndpoint boolean

Enable HTTP endpoint (data API). Only valid when engine_mode is set to serverless.

enabledCloudwatchLogsExports string[]

List of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, error, general, slowquery, postgresql (PostgreSQL).

endpoint string

The DNS address of the RDS instance

engine EngineType

The name of the database engine to be used for this DB cluster. Defaults to aurora. Valid Values: aurora, aurora-mysql, aurora-postgresql

engineMode EngineMode

The database engine mode. Valid values: global, multimaster, parallelquery, provisioned, serverless. Defaults to: provisioned. See the RDS User Guide for limitations when using serverless.

engineVersion string

The database engine version. Updating this argument results in an outage. See the Aurora MySQL and Aurora Postgres documentation for your configured engine to determine this value. For example with Aurora MySQL 2, a potential value for this argument is 5.7.mysql_aurora.2.03.2.

finalSnapshotIdentifier string

The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.

globalClusterIdentifier string

The global cluster identifier specified on aws.rds.GlobalCluster.

hostedZoneId string

The Route53 Hosted Zone ID of the endpoint

iamDatabaseAuthenticationEnabled boolean

Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Please see AWS Documentation for availability and limitations.

iamRoles string[]

A List of ARNs for the IAM roles to associate to the RDS Cluster.

kmsKeyId string

The ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.

masterPassword string

Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the RDS Naming Constraints

masterUsername string

Username for the master DB user. Please refer to the RDS Naming Constraints. This argument does not support in-place updates and cannot be changed during a restore from snapshot.

port number

The port on which the DB accepts connections

preferredBackupWindow string

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC. Default: A 30-minute window selected at random from an 8-hour block of time per region. e.g. 04:00-09:00

preferredMaintenanceWindow string

The weekly time range during which system maintenance can occur, in (UTC) e.g. wed:04:00-wed:04:30

readerEndpoint string

A read-only endpoint for the Aurora cluster, automatically load-balanced across replicas

replicationSourceIdentifier string

ARN of a source DB cluster or DB instance if this DB cluster is to be created as a Read Replica.

s3Import ClusterS3Import

scalingConfiguration ClusterScalingConfiguration

Nested attribute with scaling properties. Only valid when engine_mode is set to serverless. More details below.

skipFinalSnapshot boolean

Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from final_snapshot_identifier. Default is false.

snapshotIdentifier string

Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot.

sourceRegion string

The source region for an encrypted replica DB cluster.

storageEncrypted boolean

Specifies whether the DB cluster is encrypted. The default is false for provisioned engine_mode and true for serverless engine_mode.

tags {[key: string]: string}

A map of tags to assign to the DB cluster.

vpcSecurityGroupIds string[]

List of VPC security groups to associate with the Cluster

apply_immediately bool

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.

arn str

Amazon Resource Name (ARN) of cluster

availability_zones List[str]

A list of EC2 Availability Zones for the DB cluster storage where DB cluster instances can be created. RDS automatically assigns 3 AZs if less than 3 AZs are configured, which will show as a difference requiring resource recreation next provider update. It is recommended to specify 3 AZs or use the ignoreChanges argument if necessary.

backtrack_window float

The target backtrack window, in seconds. Only available for aurora engine currently. To disable backtracking, set this value to 0. Defaults to 0. Must be between 0 and 259200 (72 hours)

backup_retention_period float

The days to retain backups for. Default 1

cluster_identifier str

The cluster identifier. If omitted, this provider will assign a random, unique identifier.

cluster_identifier_prefix str

Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.

cluster_members List[str]

List of RDS Instances that are a part of this cluster

cluster_resource_id str

The RDS Cluster Resource ID

copy_tags_to_snapshot bool

Copy all Cluster tags to snapshots. Default is false.

database_name str

Name for an automatically created database on cluster creation. There are different naming restrictions per database engine: RDS Naming Constraints

db_cluster_parameter_group_name str

A cluster parameter group to associate with the cluster.

db_subnet_group_name str

A DB subnet group to associate with this DB instance. NOTE: This must match the db_subnet_group_name specified on every aws.rds.ClusterInstance in the cluster.

deletion_protection bool

If the DB instance should have deletion protection enabled. The database can’t be deleted when this value is set to true. The default is false.

enable_http_endpoint bool

Enable HTTP endpoint (data API). Only valid when engine_mode is set to serverless.

enabled_cloudwatch_logs_exports List[str]

List of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, error, general, slowquery, postgresql (PostgreSQL).

endpoint str

The DNS address of the RDS instance

engine str

The name of the database engine to be used for this DB cluster. Defaults to aurora. Valid Values: aurora, aurora-mysql, aurora-postgresql

engine_mode str

The database engine mode. Valid values: global, multimaster, parallelquery, provisioned, serverless. Defaults to: provisioned. See the RDS User Guide for limitations when using serverless.

engine_version str

The database engine version. Updating this argument results in an outage. See the Aurora MySQL and Aurora Postgres documentation for your configured engine to determine this value. For example with Aurora MySQL 2, a potential value for this argument is 5.7.mysql_aurora.2.03.2.

final_snapshot_identifier str

The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.

global_cluster_identifier str

The global cluster identifier specified on aws.rds.GlobalCluster.

hosted_zone_id str

The Route53 Hosted Zone ID of the endpoint

iam_database_authentication_enabled bool

Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Please see AWS Documentation for availability and limitations.

iam_roles List[str]

A List of ARNs for the IAM roles to associate to the RDS Cluster.

kms_key_id str

The ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.

master_password str

Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the RDS Naming Constraints

master_username str

Username for the master DB user. Please refer to the RDS Naming Constraints. This argument does not support in-place updates and cannot be changed during a restore from snapshot.

port float

The port on which the DB accepts connections

preferred_backup_window str

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC. Default: A 30-minute window selected at random from an 8-hour block of time per region. e.g. 04:00-09:00

preferred_maintenance_window str

The weekly time range during which system maintenance can occur, in (UTC) e.g. wed:04:00-wed:04:30

reader_endpoint str

A read-only endpoint for the Aurora cluster, automatically load-balanced across replicas

replication_source_identifier str

ARN of a source DB cluster or DB instance if this DB cluster is to be created as a Read Replica.

s3_import Dict[ClusterS3Import]

scaling_configuration Dict[ClusterScalingConfiguration]

Nested attribute with scaling properties. Only valid when engine_mode is set to serverless. More details below.

skip_final_snapshot bool

Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from final_snapshot_identifier. Default is false.

snapshot_identifier str

Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot.

source_region str

The source region for an encrypted replica DB cluster.

storage_encrypted bool

Specifies whether the DB cluster is encrypted. The default is false for provisioned engine_mode and true for serverless engine_mode.

tags Dict[str, str]

A map of tags to assign to the DB cluster.

vpc_security_group_ids List[str]

List of VPC security groups to associate with the Cluster

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

BucketName string

The bucket name where your backup is stored

IngestionRole string

Role applied to load the data.

SourceEngine string

Source engine for the backup

SourceEngineVersion string

Version of the source engine used to make the backup

BucketPrefix string

Can be blank, but is the path to your backup

BucketName string

The bucket name where your backup is stored

IngestionRole string

Role applied to load the data.

SourceEngine string

Source engine for the backup

SourceEngineVersion string

Version of the source engine used to make the backup

BucketPrefix string

Can be blank, but is the path to your backup

bucketName string

The bucket name where your backup is stored

ingestionRole string

Role applied to load the data.

sourceEngine string

Source engine for the backup

sourceEngineVersion string

Version of the source engine used to make the backup

bucketPrefix string

Can be blank, but is the path to your backup

bucket_name str

The bucket name where your backup is stored

ingestionRole str

Role applied to load the data.

sourceEngine str

Source engine for the backup

sourceEngineVersion str

Version of the source engine used to make the backup

bucket_prefix str

Can be blank, but is the path to your backup

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

AutoPause bool

Whether to enable automatic pause. A DB cluster can be paused only when it’s idle (it has no connections). If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it. Defaults to true.

MaxCapacity int

The maximum capacity. The maximum capacity must be greater than or equal to the minimum capacity. Valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. Defaults to 16.

MinCapacity int

The minimum capacity. The minimum capacity must be lesser than or equal to the maximum capacity. Valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. Defaults to 2.

SecondsUntilAutoPause int

The time, in seconds, before an Aurora DB cluster in serverless mode is paused. Valid values are 300 through 86400. Defaults to 300.

TimeoutAction string

The action to take when the timeout is reached. Valid values: ForceApplyCapacityChange, RollbackCapacityChange. Defaults to RollbackCapacityChange. See documentation.

AutoPause bool

Whether to enable automatic pause. A DB cluster can be paused only when it’s idle (it has no connections). If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it. Defaults to true.

MaxCapacity int

The maximum capacity. The maximum capacity must be greater than or equal to the minimum capacity. Valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. Defaults to 16.

MinCapacity int

The minimum capacity. The minimum capacity must be lesser than or equal to the maximum capacity. Valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. Defaults to 2.

SecondsUntilAutoPause int

The time, in seconds, before an Aurora DB cluster in serverless mode is paused. Valid values are 300 through 86400. Defaults to 300.

TimeoutAction string

The action to take when the timeout is reached. Valid values: ForceApplyCapacityChange, RollbackCapacityChange. Defaults to RollbackCapacityChange. See documentation.

autoPause boolean

Whether to enable automatic pause. A DB cluster can be paused only when it’s idle (it has no connections). If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it. Defaults to true.

maxCapacity number

The maximum capacity. The maximum capacity must be greater than or equal to the minimum capacity. Valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. Defaults to 16.

minCapacity number

The minimum capacity. The minimum capacity must be lesser than or equal to the maximum capacity. Valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. Defaults to 2.

secondsUntilAutoPause number

The time, in seconds, before an Aurora DB cluster in serverless mode is paused. Valid values are 300 through 86400. Defaults to 300.

timeoutAction string

The action to take when the timeout is reached. Valid values: ForceApplyCapacityChange, RollbackCapacityChange. Defaults to RollbackCapacityChange. See documentation.

autoPause bool

Whether to enable automatic pause. A DB cluster can be paused only when it’s idle (it has no connections). If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it. Defaults to true.

max_capacity float

The maximum capacity. The maximum capacity must be greater than or equal to the minimum capacity. Valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. Defaults to 16.

min_capacity float

The minimum capacity. The minimum capacity must be lesser than or equal to the maximum capacity. Valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. Defaults to 2.

secondsUntilAutoPause float

The time, in seconds, before an Aurora DB cluster in serverless mode is paused. Valid values are 300 through 86400. Defaults to 300.

timeoutAction str

The action to take when the timeout is reached. Valid values: ForceApplyCapacityChange, RollbackCapacityChange. Defaults to RollbackCapacityChange. See documentation.