ProvisionedClusterInstanceProps

class aws_cdk.aws_rds.ProvisionedClusterInstanceProps(*, allow_major_version_upgrade=None, apply_immediately=None, auto_minor_version_upgrade=None, availability_zone=None, ca_certificate=None, enable_performance_insights=None, instance_identifier=None, is_from_legacy_instance_props=None, parameter_group=None, parameters=None, performance_insight_encryption_key=None, performance_insight_retention=None, preferred_maintenance_window=None, publicly_accessible=None, instance_type=None, promotion_tier=None)

Bases: ClusterInstanceOptions

Options for creating a provisioned instance.

Parameters:

  • allow_major_version_upgrade (Optional[bool]) – Whether to allow upgrade of major version for the DB instance. Default: - false

  • apply_immediately (Optional[bool]) – Specifies whether changes to the DB instance and any pending modifications are applied immediately, regardless of the preferredMaintenanceWindow setting. If set to false, changes are applied during the next maintenance window. Until RDS applies the changes, the DB instance remains in a drift state. As a result, the configuration doesn’t fully reflect the requested modifications and temporarily diverges from the intended state. This property also determines whether the DB instance reboots when a static parameter is modified in the associated DB parameter group. Default: - Changes will be applied immediately

  • auto_minor_version_upgrade (Optional[bool]) – Whether to enable automatic upgrade of minor version for the DB instance. Default: - true

  • availability_zone (Optional[str]) – The Availability Zone (AZ) where the database will be created. For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don’t specify one. Default: - A random, system-chosen Availability Zone in the endpointʼs AWS Region.

  • ca_certificate (Optional[CaCertificate]) – The identifier of the CA certificate for this DB cluster’s instances. Specifying or updating this property triggers a reboot. For RDS DB engines: Default: - RDS will choose a certificate authority

  • enable_performance_insights (Optional[bool]) – Whether to enable Performance Insights for the DB instance. Default: - false, unless performanceInsightRetention or performanceInsightEncryptionKey is set.

  • instance_identifier (Optional[str]) – The identifier for the database instance. Default: - CloudFormation generated identifier

  • is_from_legacy_instance_props (Optional[bool]) – Only used for migrating existing clusters from using instanceProps to writer and readers. Default: false

  • parameter_group (Optional[IParameterGroup]) – The DB parameter group to associate with the instance. This is only needed if you need to configure different parameter groups for each individual instance, otherwise you should not provide this and just use the cluster parameter group Default: the cluster parameter group is used

  • parameters (Optional[Mapping[str, str]]) – The parameters in the DBParameterGroup to create automatically. You can only specify parameterGroup or parameters but not both. You need to use a versioned engine to auto-generate a DBParameterGroup. Default: - None

  • performance_insight_encryption_key (Optional[IKey]) – The AWS KMS key for encryption of Performance Insights data. Default: - default master key

  • performance_insight_retention (Optional[PerformanceInsightRetention]) – The amount of time, in days, to retain Performance Insights data. Default: 7

  • preferred_maintenance_window (Optional[str]) – A preferred maintenance window day/time range. Should be specified as a range ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). Example: ‘Sun:23:45-Mon:00:15’ Default: - 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.

  • publicly_accessible (Optional[bool]) – Indicates whether the DB instance is an internet-facing instance. If not specified, the cluster’s vpcSubnets will be used to determine if the instance is internet-facing or not. Default: - true if the cluster’s vpcSubnets is subnetType: SubnetType.PUBLIC, false otherwise

  • instance_type (Optional[InstanceType]) – The cluster instance type. Default: db.t3.medium

  • promotion_tier (Union[int, float, None]) – The promotion tier of the cluster instance. Can be between 0-15 For provisioned instances this just determines the failover priority. If multiple instances have the same priority then one will be picked at random Default: 2

ExampleMetadata:

infused

Example:

# vpc: ec2.Vpc

cluster = rds.DatabaseCluster(self, "Database",
    engine=rds.DatabaseClusterEngine.aurora_mysql(version=rds.AuroraMysqlEngineVersion.VER_3_01_0),
    writer=rds.ClusterInstance.provisioned("Instance",
        instance_type=ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE3, ec2.InstanceSize.SMALL)
    ),
    readers=[rds.ClusterInstance.provisioned("reader")],
    instance_update_behaviour=rds.InstanceUpdateBehaviour.ROLLING,  # Optional - defaults to rds.InstanceUpdateBehaviour.BULK
    vpc=vpc
)

Attributes

allow_major_version_upgrade

Whether to allow upgrade of major version for the DB instance.

Default:

  • false

apply_immediately

Specifies whether changes to the DB instance and any pending modifications are applied immediately, regardless of the preferredMaintenanceWindow setting.

If set to false, changes are applied during the next maintenance window.

Until RDS applies the changes, the DB instance remains in a drift state. As a result, the configuration doesn’t fully reflect the requested modifications and temporarily diverges from the intended state.

This property also determines whether the DB instance reboots when a static parameter is modified in the associated DB parameter group.

Default:

  • Changes will be applied immediately

See:

https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Modifying.html

auto_minor_version_upgrade

Whether to enable automatic upgrade of minor version for the DB instance.

Default:

  • true

availability_zone

The Availability Zone (AZ) where the database will be created.

For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don’t specify one.

Default:

  • A random, system-chosen Availability Zone in the endpointʼs AWS Region.

See:

https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html

ca_certificate

The identifier of the CA certificate for this DB cluster’s instances.

Specifying or updating this property triggers a reboot.

For RDS DB engines:

Default:

  • RDS will choose a certificate authority

See:

https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html

enable_performance_insights

Whether to enable Performance Insights for the DB instance.

Default:

  • false, unless performanceInsightRetention or performanceInsightEncryptionKey is set.

instance_identifier

The identifier for the database instance.

Default:

  • CloudFormation generated identifier

instance_type

The cluster instance type.

Default:

db.t3.medium

is_from_legacy_instance_props

Only used for migrating existing clusters from using instanceProps to writer and readers.

Default:

false

Example:

# existing cluster
# vpc: ec2.Vpc

cluster = rds.DatabaseCluster(self, "Database",
    engine=rds.DatabaseClusterEngine.aurora_mysql(
        version=rds.AuroraMysqlEngineVersion.VER_3_03_0
    ),
    instances=2,
    instance_props=rds.InstanceProps(
        instance_type=ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE3, ec2.InstanceSize.SMALL),
        vpc_subnets=ec2.SubnetSelection(subnet_type=ec2.SubnetType.PUBLIC),
        vpc=vpc
    )
)

# migration

instance_props = {
    "instance_type": ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE3, ec2.InstanceSize.SMALL),
    "is_from_legacy_instance_props": True
}

my_cluster = rds.DatabaseCluster(self, "Database",
    engine=rds.DatabaseClusterEngine.aurora_mysql(
        version=rds.AuroraMysqlEngineVersion.VER_3_03_0
    ),
    vpc_subnets=ec2.SubnetSelection(subnet_type=ec2.SubnetType.PUBLIC),
    vpc=vpc,
    writer=rds.ClusterInstance.provisioned("Instance1",
        instance_type=instance_props.instance_type,
        is_from_legacy_instance_props=instance_props.is_from_legacy_instance_props
    ),
    readers=[
        rds.ClusterInstance.provisioned("Instance2",
            instance_type=instance_props.instance_type,
            is_from_legacy_instance_props=instance_props.is_from_legacy_instance_props
        )
    ]
)
parameter_group

The DB parameter group to associate with the instance.

This is only needed if you need to configure different parameter groups for each individual instance, otherwise you should not provide this and just use the cluster parameter group

Default:

the cluster parameter group is used

parameters

The parameters in the DBParameterGroup to create automatically.

You can only specify parameterGroup or parameters but not both. You need to use a versioned engine to auto-generate a DBParameterGroup.

Default:

  • None

performance_insight_encryption_key

The AWS KMS key for encryption of Performance Insights data.

Default:

  • default master key

performance_insight_retention

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

Default:

7

preferred_maintenance_window

mi-ddd:hh24:mi (24H Clock UTC).

Example: ‘Sun:23:45-Mon:00:15’

Default:

  • 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.

See:

https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance

Type:

A preferred maintenance window day/time range. Should be specified as a range ddd

Type:

hh24

promotion_tier

The promotion tier of the cluster instance.

Can be between 0-15

For provisioned instances this just determines the failover priority. If multiple instances have the same priority then one will be picked at random

Default:

2

publicly_accessible

Indicates whether the DB instance is an internet-facing instance.

If not specified, the cluster’s vpcSubnets will be used to determine if the instance is internet-facing or not.

Default:

  • true if the cluster’s vpcSubnets is subnetType: SubnetType.PUBLIC, false otherwise