AWS Native

v0.29.0 published on Thursday, Sep 8, 2022 by Pulumi

DBCluster

The AWS::RDS::DBCluster resource creates an Amazon Aurora DB cluster.

Create a DBCluster Resource

new DBCluster(name: string, args?: DBClusterArgs, opts?: CustomResourceOptions);
@overload
def DBCluster(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              allocated_storage: Optional[int] = None,
              associated_roles: Optional[Sequence[DBClusterRoleArgs]] = None,
              auto_minor_version_upgrade: Optional[bool] = None,
              availability_zones: Optional[Sequence[str]] = None,
              backtrack_window: Optional[int] = None,
              backup_retention_period: Optional[int] = None,
              copy_tags_to_snapshot: Optional[bool] = None,
              d_b_cluster_identifier: Optional[str] = None,
              d_b_cluster_instance_class: Optional[str] = None,
              d_b_cluster_parameter_group_name: Optional[str] = None,
              d_b_subnet_group_name: Optional[str] = None,
              database_name: Optional[str] = None,
              deletion_protection: Optional[bool] = None,
              enable_cloudwatch_logs_exports: Optional[Sequence[str]] = None,
              enable_http_endpoint: Optional[bool] = None,
              enable_iam_database_authentication: Optional[bool] = None,
              engine: Optional[str] = None,
              engine_mode: Optional[str] = None,
              engine_version: Optional[str] = None,
              global_cluster_identifier: Optional[str] = None,
              iops: Optional[int] = None,
              kms_key_id: Optional[str] = None,
              master_user_password: Optional[str] = None,
              master_username: Optional[str] = None,
              monitoring_interval: Optional[int] = None,
              monitoring_role_arn: Optional[str] = None,
              performance_insights_enabled: Optional[bool] = None,
              performance_insights_kms_key_id: Optional[str] = None,
              performance_insights_retention_period: Optional[int] = None,
              port: Optional[int] = None,
              preferred_backup_window: Optional[str] = None,
              preferred_maintenance_window: Optional[str] = None,
              publicly_accessible: Optional[bool] = None,
              read_endpoint: Optional[DBClusterReadEndpointArgs] = None,
              replication_source_identifier: Optional[str] = None,
              restore_type: Optional[str] = None,
              scaling_configuration: Optional[DBClusterScalingConfigurationArgs] = None,
              snapshot_identifier: Optional[str] = None,
              source_db_cluster_identifier: Optional[str] = None,
              source_region: Optional[str] = None,
              storage_encrypted: Optional[bool] = None,
              storage_type: Optional[str] = None,
              tags: Optional[Sequence[DBClusterTagArgs]] = None,
              use_latest_restorable_time: Optional[bool] = None,
              vpc_security_group_ids: Optional[Sequence[str]] = None)
@overload
def DBCluster(resource_name: str,
              args: Optional[DBClusterArgs] = None,
              opts: Optional[ResourceOptions] = None)
func NewDBCluster(ctx *Context, name string, args *DBClusterArgs, opts ...ResourceOption) (*DBCluster, error)
public DBCluster(string name, DBClusterArgs? args = null, CustomResourceOptions? opts = null)
public DBCluster(String name, DBClusterArgs args)
public DBCluster(String name, DBClusterArgs args, CustomResourceOptions options)
type: aws-native:rds:DBCluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args DBClusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args DBClusterArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args DBClusterArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DBClusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args DBClusterArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

DBCluster Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The DBCluster resource accepts the following input properties:

AllocatedStorage int

The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

AssociatedRoles List<Pulumi.AwsNative.RDS.Inputs.DBClusterRoleArgs>

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.

AutoMinorVersionUpgrade bool

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.

AvailabilityZones List<string>

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.

BacktrackWindow int

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

BackupRetentionPeriod int

The number of days for which automated backups are retained.

CopyTagsToSnapshot bool

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

DBClusterIdentifier string

The DB cluster identifier. This parameter is stored as a lowercase string.

DBClusterInstanceClass string

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.

DBClusterParameterGroupName string

The name of the DB cluster parameter group to associate with this DB cluster.

DBSubnetGroupName string

A DB subnet group that you want to associate with this DB cluster.

DatabaseName string

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.

DeletionProtection bool

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

EnableCloudwatchLogsExports List<string>

The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

EnableHttpEndpoint bool

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.

EnableIAMDatabaseAuthentication bool

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

Engine string

The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql

EngineMode string

The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

EngineVersion string

The version number of the database engine to use.

GlobalClusterIdentifier string

If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster. To define the primary database cluster of the global cluster, use the AWS::RDS::GlobalCluster resource.

If you aren't configuring a global database cluster, don't specify this property.

Iops int

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.

KmsKeyId string

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.

MasterUserPassword string

The master password for the DB instance.

MasterUsername string

The name of the master user for the DB cluster. You must specify MasterUsername, unless you specify SnapshotIdentifier. In that case, don't specify MasterUsername.

MonitoringInterval int

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.

MonitoringRoleArn string

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

PerformanceInsightsEnabled bool

A value that indicates whether to turn on Performance Insights for the DB cluster.

PerformanceInsightsKmsKeyId string

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

PerformanceInsightsRetentionPeriod int

The amount of time, in days, to retain Performance Insights data.

Port int

The port number on which the instances in the DB cluster accept connections. Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.

PreferredBackupWindow string

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.

PreferredMaintenanceWindow string

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.

PubliclyAccessible bool

A value that indicates whether the DB cluster is publicly accessible.

ReadEndpoint Pulumi.AwsNative.RDS.Inputs.DBClusterReadEndpointArgs
ReplicationSourceIdentifier string

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.

RestoreType string

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.

ScalingConfiguration Pulumi.AwsNative.RDS.Inputs.DBClusterScalingConfigurationArgs

The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster.

SnapshotIdentifier string

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.

SourceDBClusterIdentifier string

The identifier of the source DB cluster from which to restore.

SourceRegion string

The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1.

StorageEncrypted bool

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.

StorageType string

Specifies the storage type to be associated with the DB cluster.

Tags List<Pulumi.AwsNative.RDS.Inputs.DBClusterTagArgs>

An array of key-value pairs to apply to this resource.

UseLatestRestorableTime bool

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.

VpcSecurityGroupIds List<string>

A list of EC2 VPC security groups to associate with this DB cluster.

AllocatedStorage int

The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

AssociatedRoles []DBClusterRoleArgs

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.

AutoMinorVersionUpgrade bool

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.

AvailabilityZones []string

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.

BacktrackWindow int

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

BackupRetentionPeriod int

The number of days for which automated backups are retained.

CopyTagsToSnapshot bool

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

DBClusterIdentifier string

The DB cluster identifier. This parameter is stored as a lowercase string.

DBClusterInstanceClass string

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.

DBClusterParameterGroupName string

The name of the DB cluster parameter group to associate with this DB cluster.

DBSubnetGroupName string

A DB subnet group that you want to associate with this DB cluster.

DatabaseName string

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.

DeletionProtection bool

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

EnableCloudwatchLogsExports []string

The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

EnableHttpEndpoint bool

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.

EnableIAMDatabaseAuthentication bool

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

Engine string

The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql

EngineMode string

The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

EngineVersion string

The version number of the database engine to use.

GlobalClusterIdentifier string

If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster. To define the primary database cluster of the global cluster, use the AWS::RDS::GlobalCluster resource.

If you aren't configuring a global database cluster, don't specify this property.

Iops int

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.

KmsKeyId string

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.

MasterUserPassword string

The master password for the DB instance.

MasterUsername string

The name of the master user for the DB cluster. You must specify MasterUsername, unless you specify SnapshotIdentifier. In that case, don't specify MasterUsername.

MonitoringInterval int

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.

MonitoringRoleArn string

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

PerformanceInsightsEnabled bool

A value that indicates whether to turn on Performance Insights for the DB cluster.

PerformanceInsightsKmsKeyId string

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

PerformanceInsightsRetentionPeriod int

The amount of time, in days, to retain Performance Insights data.

Port int

The port number on which the instances in the DB cluster accept connections. Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.

PreferredBackupWindow string

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.

PreferredMaintenanceWindow string

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.

PubliclyAccessible bool

A value that indicates whether the DB cluster is publicly accessible.

ReadEndpoint DBClusterReadEndpointArgs
ReplicationSourceIdentifier string

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.

RestoreType string

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.

ScalingConfiguration DBClusterScalingConfigurationArgs

The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster.

SnapshotIdentifier string

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.

SourceDBClusterIdentifier string

The identifier of the source DB cluster from which to restore.

SourceRegion string

The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1.

StorageEncrypted bool

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.

StorageType string

Specifies the storage type to be associated with the DB cluster.

Tags []DBClusterTagArgs

An array of key-value pairs to apply to this resource.

UseLatestRestorableTime bool

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.

VpcSecurityGroupIds []string

A list of EC2 VPC security groups to associate with this DB cluster.

allocatedStorage Integer

The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

associatedRoles List<DBClusterRoleArgs>

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.

autoMinorVersionUpgrade Boolean

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.

availabilityZones List<String>

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.

backtrackWindow Integer

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

backupRetentionPeriod Integer

The number of days for which automated backups are retained.

copyTagsToSnapshot Boolean

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

dBClusterIdentifier String

The DB cluster identifier. This parameter is stored as a lowercase string.

dBClusterInstanceClass String

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.

dBClusterParameterGroupName String

The name of the DB cluster parameter group to associate with this DB cluster.

dBSubnetGroupName String

A DB subnet group that you want to associate with this DB cluster.

databaseName String

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.

deletionProtection Boolean

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

enableCloudwatchLogsExports List<String>

The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

enableHttpEndpoint Boolean

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.

enableIAMDatabaseAuthentication Boolean

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

engine String

The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql

engineMode String

The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

engineVersion String

The version number of the database engine to use.

globalClusterIdentifier String

If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster. To define the primary database cluster of the global cluster, use the AWS::RDS::GlobalCluster resource.

If you aren't configuring a global database cluster, don't specify this property.

iops Integer

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.

kmsKeyId String

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.

masterUserPassword String

The master password for the DB instance.

masterUsername String

The name of the master user for the DB cluster. You must specify MasterUsername, unless you specify SnapshotIdentifier. In that case, don't specify MasterUsername.

monitoringInterval Integer

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.

monitoringRoleArn String

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

performanceInsightsEnabled Boolean

A value that indicates whether to turn on Performance Insights for the DB cluster.

performanceInsightsKmsKeyId String

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

performanceInsightsRetentionPeriod Integer

The amount of time, in days, to retain Performance Insights data.

port Integer

The port number on which the instances in the DB cluster accept connections. Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.

preferredBackupWindow String

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.

preferredMaintenanceWindow String

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.

publiclyAccessible Boolean

A value that indicates whether the DB cluster is publicly accessible.

readEndpoint DBClusterReadEndpointArgs
replicationSourceIdentifier String

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.

restoreType String

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.

scalingConfiguration DBClusterScalingConfigurationArgs

The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster.

snapshotIdentifier String

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.

sourceDBClusterIdentifier String

The identifier of the source DB cluster from which to restore.

sourceRegion String

The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1.

storageEncrypted Boolean

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.

storageType String

Specifies the storage type to be associated with the DB cluster.

tags List<DBClusterTagArgs>

An array of key-value pairs to apply to this resource.

useLatestRestorableTime Boolean

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.

vpcSecurityGroupIds List<String>

A list of EC2 VPC security groups to associate with this DB cluster.

allocatedStorage number

The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

associatedRoles DBClusterRoleArgs[]

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.

autoMinorVersionUpgrade boolean

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.

availabilityZones string[]

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.

backtrackWindow number

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

backupRetentionPeriod number

The number of days for which automated backups are retained.

copyTagsToSnapshot boolean

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

dBClusterIdentifier string

The DB cluster identifier. This parameter is stored as a lowercase string.

dBClusterInstanceClass string

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.

dBClusterParameterGroupName string

The name of the DB cluster parameter group to associate with this DB cluster.

dBSubnetGroupName string

A DB subnet group that you want to associate with this DB cluster.

databaseName string

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.

deletionProtection boolean

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

enableCloudwatchLogsExports string[]

The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

enableHttpEndpoint boolean

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.

enableIAMDatabaseAuthentication boolean

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

engine string

The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql

engineMode string

The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

engineVersion string

The version number of the database engine to use.

globalClusterIdentifier string

If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster. To define the primary database cluster of the global cluster, use the AWS::RDS::GlobalCluster resource.

If you aren't configuring a global database cluster, don't specify this property.

iops number

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.

kmsKeyId string

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.

masterUserPassword string

The master password for the DB instance.

masterUsername string

The name of the master user for the DB cluster. You must specify MasterUsername, unless you specify SnapshotIdentifier. In that case, don't specify MasterUsername.

monitoringInterval number

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.

monitoringRoleArn string

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

performanceInsightsEnabled boolean

A value that indicates whether to turn on Performance Insights for the DB cluster.

performanceInsightsKmsKeyId string

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

performanceInsightsRetentionPeriod number

The amount of time, in days, to retain Performance Insights data.

port number

The port number on which the instances in the DB cluster accept connections. Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.

preferredBackupWindow string

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.

preferredMaintenanceWindow string

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.

publiclyAccessible boolean

A value that indicates whether the DB cluster is publicly accessible.

readEndpoint DBClusterReadEndpointArgs
replicationSourceIdentifier string

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.

restoreType string

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.

scalingConfiguration DBClusterScalingConfigurationArgs

The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster.

snapshotIdentifier string

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.

sourceDBClusterIdentifier string

The identifier of the source DB cluster from which to restore.

sourceRegion string

The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1.

storageEncrypted boolean

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.

storageType string

Specifies the storage type to be associated with the DB cluster.

tags DBClusterTagArgs[]

An array of key-value pairs to apply to this resource.

useLatestRestorableTime boolean

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.

vpcSecurityGroupIds string[]

A list of EC2 VPC security groups to associate with this DB cluster.

allocated_storage int

The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

associated_roles Sequence[DBClusterRoleArgs]

Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.

auto_minor_version_upgrade bool

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.

availability_zones Sequence[str]

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.

backtrack_window int

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

backup_retention_period int

The number of days for which automated backups are retained.

copy_tags_to_snapshot bool

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

d_b_cluster_identifier str

The DB cluster identifier. This parameter is stored as a lowercase string.

d_b_cluster_instance_class str

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.

d_b_cluster_parameter_group_name str

The name of the DB cluster parameter group to associate with this DB cluster.

d_b_subnet_group_name str

A DB subnet group that you want to associate with this DB cluster.

database_name str

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.

deletion_protection bool

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

enable_cloudwatch_logs_exports Sequence[str]

The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

enable_http_endpoint bool

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.

enable_iam_database_authentication bool

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

engine str

The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql

engine_mode str

The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

engine_version str

The version number of the database engine to use.

global_cluster_identifier str

If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster. To define the primary database cluster of the global cluster, use the AWS::RDS::GlobalCluster resource.

If you aren't configuring a global database cluster, don't specify this property.

iops int

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.

kms_key_id str

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.

master_user_password str

The master password for the DB instance.

master_username str

The name of the master user for the DB cluster. You must specify MasterUsername, unless you specify SnapshotIdentifier. In that case, don't specify MasterUsername.

monitoring_interval int

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.

monitoring_role_arn str

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

performance_insights_enabled bool

A value that indicates whether to turn on Performance Insights for the DB cluster.

performance_insights_kms_key_id str

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

performance_insights_retention_period int

The amount of time, in days, to retain Performance Insights data.

port int

The port number on which the instances in the DB cluster accept connections. Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.

preferred_backup_window str

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

preferred_maintenance_window str

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.

publicly_accessible bool

A value that indicates whether the DB cluster is publicly accessible.

read_endpoint DBClusterReadEndpointArgs
replication_source_identifier str

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.

restore_type str

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.

scaling_configuration DBClusterScalingConfigurationArgs

The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster.

snapshot_identifier str

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.

source_db_cluster_identifier str

The identifier of the source DB cluster from which to restore.

source_region str

The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1.

storage_encrypted bool

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.

storage_type str

Specifies the storage type to be associated with the DB cluster.

tags Sequence[DBClusterTagArgs]

An array of key-value pairs to apply to this resource.

use_latest_restorable_time bool

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.

vpc_security_group_ids Sequence[str]

A list of EC2 VPC security groups to associate with this DB cluster.

allocatedStorage Number

The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

associatedRoles List<Property Map>

Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.

autoMinorVersionUpgrade Boolean

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.

availabilityZones List<String>

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.

backtrackWindow Number

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

backupRetentionPeriod Number

The number of days for which automated backups are retained.

copyTagsToSnapshot Boolean

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

dBClusterIdentifier String

The DB cluster identifier. This parameter is stored as a lowercase string.

dBClusterInstanceClass String

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.

dBClusterParameterGroupName String

The name of the DB cluster parameter group to associate with this DB cluster.

dBSubnetGroupName String

A DB subnet group that you want to associate with this DB cluster.

databaseName String

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.

deletionProtection Boolean

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

enableCloudwatchLogsExports List<String>

The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

enableHttpEndpoint Boolean

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.

enableIAMDatabaseAuthentication Boolean

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

engine String

The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql

engineMode String

The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

engineVersion String

The version number of the database engine to use.

globalClusterIdentifier String

If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster. To define the primary database cluster of the global cluster, use the AWS::RDS::GlobalCluster resource.

If you aren't configuring a global database cluster, don't specify this property.

iops Number

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.

kmsKeyId String

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.

masterUserPassword String

The master password for the DB instance.

masterUsername String

The name of the master user for the DB cluster. You must specify MasterUsername, unless you specify SnapshotIdentifier. In that case, don't specify MasterUsername.

monitoringInterval Number

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.

monitoringRoleArn String

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

performanceInsightsEnabled Boolean

A value that indicates whether to turn on Performance Insights for the DB cluster.

performanceInsightsKmsKeyId String

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

performanceInsightsRetentionPeriod Number

The amount of time, in days, to retain Performance Insights data.

port Number

The port number on which the instances in the DB cluster accept connections. Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.

preferredBackupWindow String

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.

preferredMaintenanceWindow String

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.

publiclyAccessible Boolean

A value that indicates whether the DB cluster is publicly accessible.

readEndpoint Property Map
replicationSourceIdentifier String

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.

restoreType String

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.

scalingConfiguration Property Map

The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster.

snapshotIdentifier String

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.

sourceDBClusterIdentifier String

The identifier of the source DB cluster from which to restore.

sourceRegion String

The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1.

storageEncrypted Boolean

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.

storageType String

Specifies the storage type to be associated with the DB cluster.

tags List<Property Map>

An array of key-value pairs to apply to this resource.

useLatestRestorableTime Boolean

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.

vpcSecurityGroupIds List<String>

A list of EC2 VPC security groups to associate with this DB cluster.

Outputs

All input properties are implicitly available as output properties. Additionally, the DBCluster resource produces the following output properties:

Endpoint Pulumi.AwsNative.RDS.Outputs.DBClusterEndpoint
Id string

The provider-assigned unique ID for this managed resource.

Endpoint DBClusterEndpoint
Id string

The provider-assigned unique ID for this managed resource.

endpoint DBClusterEndpoint
id String

The provider-assigned unique ID for this managed resource.

endpoint DBClusterEndpoint
id string

The provider-assigned unique ID for this managed resource.

endpoint DBClusterEndpoint
id str

The provider-assigned unique ID for this managed resource.

endpoint Property Map
id String

The provider-assigned unique ID for this managed resource.

Supporting Types

DBClusterEndpoint

Address string

The connection endpoint for the DB cluster.

Port string

The port number that will accept connections on this DB cluster.

Address string

The connection endpoint for the DB cluster.

Port string

The port number that will accept connections on this DB cluster.

address String

The connection endpoint for the DB cluster.

port String

The port number that will accept connections on this DB cluster.

address string

The connection endpoint for the DB cluster.

port string

The port number that will accept connections on this DB cluster.

address str

The connection endpoint for the DB cluster.

port str

The port number that will accept connections on this DB cluster.

address String

The connection endpoint for the DB cluster.

port String

The port number that will accept connections on this DB cluster.

DBClusterReadEndpoint

Address string

The reader endpoint for the DB cluster.

Address string

The reader endpoint for the DB cluster.

address String

The reader endpoint for the DB cluster.

address string

The reader endpoint for the DB cluster.

address str

The reader endpoint for the DB cluster.

address String

The reader endpoint for the DB cluster.

DBClusterRole

RoleArn string

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

FeatureName string

The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon RDS API Reference.

RoleArn string

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

FeatureName string

The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon RDS API Reference.

roleArn String

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

featureName String

The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon RDS API Reference.

roleArn string

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

featureName string

The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon RDS API Reference.

role_arn str

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

feature_name str

The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon RDS API Reference.

roleArn String

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

featureName String

The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon RDS API Reference.

DBClusterScalingConfiguration

AutoPause bool

A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).

MaxCapacity int

The maximum capacity for an Aurora DB cluster in serverless DB engine mode. For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. The maximum capacity must be greater than or equal to the minimum capacity.

MinCapacity int

The minimum capacity for an Aurora DB cluster in serverless DB engine mode. For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. The minimum capacity must be less than or equal to the maximum capacity.

SecondsUntilAutoPause int

The time, in seconds, before an Aurora DB cluster in serverless mode is paused.

AutoPause bool

A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).

MaxCapacity int

The maximum capacity for an Aurora DB cluster in serverless DB engine mode. For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. The maximum capacity must be greater than or equal to the minimum capacity.

MinCapacity int

The minimum capacity for an Aurora DB cluster in serverless DB engine mode. For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. The minimum capacity must be less than or equal to the maximum capacity.

SecondsUntilAutoPause int

The time, in seconds, before an Aurora DB cluster in serverless mode is paused.

autoPause Boolean

A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).

maxCapacity Integer

The maximum capacity for an Aurora DB cluster in serverless DB engine mode. For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. The maximum capacity must be greater than or equal to the minimum capacity.

minCapacity Integer

The minimum capacity for an Aurora DB cluster in serverless DB engine mode. For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. The minimum capacity must be less than or equal to the maximum capacity.

secondsUntilAutoPause Integer

The time, in seconds, before an Aurora DB cluster in serverless mode is paused.

autoPause boolean

A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).

maxCapacity number

The maximum capacity for an Aurora DB cluster in serverless DB engine mode. For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. The maximum capacity must be greater than or equal to the minimum capacity.

minCapacity number

The minimum capacity for an Aurora DB cluster in serverless DB engine mode. For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. The minimum capacity must be less than or equal to the maximum capacity.

secondsUntilAutoPause number

The time, in seconds, before an Aurora DB cluster in serverless mode is paused.

auto_pause bool

A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).

max_capacity int

The maximum capacity for an Aurora DB cluster in serverless DB engine mode. For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. The maximum capacity must be greater than or equal to the minimum capacity.

min_capacity int

The minimum capacity for an Aurora DB cluster in serverless DB engine mode. For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. The minimum capacity must be less than or equal to the maximum capacity.

seconds_until_auto_pause int

The time, in seconds, before an Aurora DB cluster in serverless mode is paused.

autoPause Boolean

A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).

maxCapacity Number

The maximum capacity for an Aurora DB cluster in serverless DB engine mode. For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. The maximum capacity must be greater than or equal to the minimum capacity.

minCapacity Number

The minimum capacity for an Aurora DB cluster in serverless DB engine mode. For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384. The minimum capacity must be less than or equal to the maximum capacity.

secondsUntilAutoPause Number

The time, in seconds, before an Aurora DB cluster in serverless mode is paused.

DBClusterTag

Key string

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Value string

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Key string

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Value string

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value String

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key string

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value string

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key str

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value str

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value String

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0