Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. rds
  5. ClusterInstance
AWS v6.75.0 published on Wednesday, Apr 2, 2025 by Pulumi
pulumi/pulumi-aws

aws.rds.ClusterInstance

Explore with Pulumi AI

AWS v6.75.0 published on Wednesday, Apr 2, 2025 by Pulumi
pulumi/pulumi-aws

Provides an RDS Cluster Instance Resource. A Cluster Instance Resource defines attributes that are specific to a single instance in a RDS Cluster, specifically running Amazon Aurora.

Unlike other RDS resources that support replication, with Amazon Aurora you do not designate a primary and subsequent replicas. Instead, you simply add RDS Instances and Aurora manages the replication. You can use the [count][5] meta-parameter to make multiple instances and join them all to the same RDS Cluster, or you may specify different Cluster Instance resources with various instance_class sizes.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

NOTE: Deletion Protection from the RDS service can only be enabled at the cluster level, not for individual cluster instances. You can still add the protect CustomResourceOption to this resource configuration if you desire protection from accidental deletion.

NOTE: aurora is no longer a valid engine because of Amazon Aurora’s MySQL-Compatible Edition version 1 end of life.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const _default = new aws.rds.Cluster("default", {
    clusterIdentifier: "aurora-cluster-demo",
    availabilityZones: [
        "us-west-2a",
        "us-west-2b",
        "us-west-2c",
    ],
    databaseName: "mydb",
    masterUsername: "foo",
    masterPassword: "barbut8chars",
});
const clusterInstances: aws.rds.ClusterInstance[] = [];
for (const range = {value: 0}; range.value < 2; range.value++) {
    clusterInstances.push(new aws.rds.ClusterInstance(`cluster_instances-${range.value}`, {
        identifier: `aurora-cluster-demo-${range.value}`,
        clusterIdentifier: _default.id,
        instanceClass: aws.rds.InstanceType.R4_Large,
        engine: _default.engine,
        engineVersion: _default.engineVersion,
    }));
}
Copy
import pulumi
import pulumi_aws as aws

default = aws.rds.Cluster("default",
    cluster_identifier="aurora-cluster-demo",
    availability_zones=[
        "us-west-2a",
        "us-west-2b",
        "us-west-2c",
    ],
    database_name="mydb",
    master_username="foo",
    master_password="barbut8chars")
cluster_instances = []
for range in [{"value": i} for i in range(0, 2)]:
    cluster_instances.append(aws.rds.ClusterInstance(f"cluster_instances-{range['value']}",
        identifier=f"aurora-cluster-demo-{range['value']}",
        cluster_identifier=default.id,
        instance_class=aws.rds.InstanceType.R4_LARGE,
        engine=default.engine,
        engine_version=default.engine_version))
Copy
package main

import (
	"fmt"

	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/rds"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_default, err := rds.NewCluster(ctx, "default", &rds.ClusterArgs{
			ClusterIdentifier: pulumi.String("aurora-cluster-demo"),
			AvailabilityZones: pulumi.StringArray{
				pulumi.String("us-west-2a"),
				pulumi.String("us-west-2b"),
				pulumi.String("us-west-2c"),
			},
			DatabaseName:   pulumi.String("mydb"),
			MasterUsername: pulumi.String("foo"),
			MasterPassword: pulumi.String("barbut8chars"),
		})
		if err != nil {
			return err
		}
		var clusterInstances []*rds.ClusterInstance
		for index := 0; index < 2; index++ {
			key0 := index
			val0 := index
			__res, err := rds.NewClusterInstance(ctx, fmt.Sprintf("cluster_instances-%v", key0), &rds.ClusterInstanceArgs{
				Identifier:        pulumi.Sprintf("aurora-cluster-demo-%v", val0),
				ClusterIdentifier: _default.ID(),
				InstanceClass:     pulumi.String(rds.InstanceType_R4_Large),
				Engine:            _default.Engine,
				EngineVersion:     _default.EngineVersion,
			})
			if err != nil {
				return err
			}
			clusterInstances = append(clusterInstances, __res)
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var @default = new Aws.Rds.Cluster("default", new()
    {
        ClusterIdentifier = "aurora-cluster-demo",
        AvailabilityZones = new[]
        {
            "us-west-2a",
            "us-west-2b",
            "us-west-2c",
        },
        DatabaseName = "mydb",
        MasterUsername = "foo",
        MasterPassword = "barbut8chars",
    });

    var clusterInstances = new List<Aws.Rds.ClusterInstance>();
    for (var rangeIndex = 0; rangeIndex < 2; rangeIndex++)
    {
        var range = new { Value = rangeIndex };
        clusterInstances.Add(new Aws.Rds.ClusterInstance($"cluster_instances-{range.Value}", new()
        {
            Identifier = $"aurora-cluster-demo-{range.Value}",
            ClusterIdentifier = @default.Id,
            InstanceClass = Aws.Rds.InstanceType.R4_Large,
            Engine = @default.Engine,
            EngineVersion = @default.EngineVersion,
        }));
    }
});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.rds.Cluster;
import com.pulumi.aws.rds.ClusterArgs;
import com.pulumi.aws.rds.ClusterInstance;
import com.pulumi.aws.rds.ClusterInstanceArgs;
import com.pulumi.codegen.internal.KeyedValue;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var default_ = new Cluster("default", ClusterArgs.builder()
            .clusterIdentifier("aurora-cluster-demo")
            .availabilityZones(            
                "us-west-2a",
                "us-west-2b",
                "us-west-2c")
            .databaseName("mydb")
            .masterUsername("foo")
            .masterPassword("barbut8chars")
            .build());

        for (var i = 0; i < 2; i++) {
            new ClusterInstance("clusterInstances-" + i, ClusterInstanceArgs.builder()
                .identifier(String.format("aurora-cluster-demo-%s", range.value()))
                .clusterIdentifier(default_.id())
                .instanceClass("db.r4.large")
                .engine(default_.engine())
                .engineVersion(default_.engineVersion())
                .build());

        
}
    }
}
Copy
resources:
  clusterInstances:
    type: aws:rds:ClusterInstance
    name: cluster_instances
    properties:
      identifier: aurora-cluster-demo-${range.value}
      clusterIdentifier: ${default.id}
      instanceClass: db.r4.large
      engine: ${default.engine}
      engineVersion: ${default.engineVersion}
    options: {}
  default:
    type: aws:rds:Cluster
    properties:
      clusterIdentifier: aurora-cluster-demo
      availabilityZones:
        - us-west-2a
        - us-west-2b
        - us-west-2c
      databaseName: mydb
      masterUsername: foo
      masterPassword: barbut8chars
Copy

Create ClusterInstance Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ClusterInstance(name: string, args: ClusterInstanceArgs, opts?: CustomResourceOptions);
@overload
def ClusterInstance(resource_name: str,
                    args: ClusterInstanceArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def ClusterInstance(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    cluster_identifier: Optional[str] = None,
                    instance_class: Optional[Union[str, InstanceType]] = None,
                    engine: Optional[str] = None,
                    identifier: Optional[str] = None,
                    auto_minor_version_upgrade: Optional[bool] = None,
                    copy_tags_to_snapshot: Optional[bool] = None,
                    custom_iam_instance_profile: Optional[str] = None,
                    db_parameter_group_name: Optional[str] = None,
                    db_subnet_group_name: Optional[str] = None,
                    availability_zone: Optional[str] = None,
                    engine_version: Optional[str] = None,
                    force_destroy: Optional[bool] = None,
                    apply_immediately: Optional[bool] = None,
                    identifier_prefix: Optional[str] = None,
                    ca_cert_identifier: 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,
                    preferred_backup_window: Optional[str] = None,
                    preferred_maintenance_window: Optional[str] = None,
                    promotion_tier: Optional[int] = None,
                    publicly_accessible: Optional[bool] = None,
                    tags: Optional[Mapping[str, str]] = None)
func NewClusterInstance(ctx *Context, name string, args ClusterInstanceArgs, opts ...ResourceOption) (*ClusterInstance, error)
public ClusterInstance(string name, ClusterInstanceArgs args, CustomResourceOptions? opts = null)
public ClusterInstance(String name, ClusterInstanceArgs args)
public ClusterInstance(String name, ClusterInstanceArgs args, CustomResourceOptions options)

type: aws:rds:ClusterInstance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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

Constructor example

The following reference example uses placeholder values for all input properties.

var exampleclusterInstanceResourceResourceFromRdsclusterInstance = new Aws.Rds.ClusterInstance("exampleclusterInstanceResourceResourceFromRdsclusterInstance", new()
{
    ClusterIdentifier = "string",
    InstanceClass = "string",
    Engine = "string",
    Identifier = "string",
    AutoMinorVersionUpgrade = false,
    CopyTagsToSnapshot = false,
    CustomIamInstanceProfile = "string",
    DbParameterGroupName = "string",
    DbSubnetGroupName = "string",
    AvailabilityZone = "string",
    EngineVersion = "string",
    ForceDestroy = false,
    ApplyImmediately = false,
    IdentifierPrefix = "string",
    CaCertIdentifier = "string",
    MonitoringInterval = 0,
    MonitoringRoleArn = "string",
    PerformanceInsightsEnabled = false,
    PerformanceInsightsKmsKeyId = "string",
    PerformanceInsightsRetentionPeriod = 0,
    PreferredBackupWindow = "string",
    PreferredMaintenanceWindow = "string",
    PromotionTier = 0,
    PubliclyAccessible = false,
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := rds.NewClusterInstance(ctx, "exampleclusterInstanceResourceResourceFromRdsclusterInstance", &rds.ClusterInstanceArgs{
	ClusterIdentifier:                  pulumi.String("string"),
	InstanceClass:                      pulumi.String("string"),
	Engine:                             pulumi.String("string"),
	Identifier:                         pulumi.String("string"),
	AutoMinorVersionUpgrade:            pulumi.Bool(false),
	CopyTagsToSnapshot:                 pulumi.Bool(false),
	CustomIamInstanceProfile:           pulumi.String("string"),
	DbParameterGroupName:               pulumi.String("string"),
	DbSubnetGroupName:                  pulumi.String("string"),
	AvailabilityZone:                   pulumi.String("string"),
	EngineVersion:                      pulumi.String("string"),
	ForceDestroy:                       pulumi.Bool(false),
	ApplyImmediately:                   pulumi.Bool(false),
	IdentifierPrefix:                   pulumi.String("string"),
	CaCertIdentifier:                   pulumi.String("string"),
	MonitoringInterval:                 pulumi.Int(0),
	MonitoringRoleArn:                  pulumi.String("string"),
	PerformanceInsightsEnabled:         pulumi.Bool(false),
	PerformanceInsightsKmsKeyId:        pulumi.String("string"),
	PerformanceInsightsRetentionPeriod: pulumi.Int(0),
	PreferredBackupWindow:              pulumi.String("string"),
	PreferredMaintenanceWindow:         pulumi.String("string"),
	PromotionTier:                      pulumi.Int(0),
	PubliclyAccessible:                 pulumi.Bool(false),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var exampleclusterInstanceResourceResourceFromRdsclusterInstance = new ClusterInstance("exampleclusterInstanceResourceResourceFromRdsclusterInstance", ClusterInstanceArgs.builder()
    .clusterIdentifier("string")
    .instanceClass("string")
    .engine("string")
    .identifier("string")
    .autoMinorVersionUpgrade(false)
    .copyTagsToSnapshot(false)
    .customIamInstanceProfile("string")
    .dbParameterGroupName("string")
    .dbSubnetGroupName("string")
    .availabilityZone("string")
    .engineVersion("string")
    .forceDestroy(false)
    .applyImmediately(false)
    .identifierPrefix("string")
    .caCertIdentifier("string")
    .monitoringInterval(0)
    .monitoringRoleArn("string")
    .performanceInsightsEnabled(false)
    .performanceInsightsKmsKeyId("string")
    .performanceInsightsRetentionPeriod(0)
    .preferredBackupWindow("string")
    .preferredMaintenanceWindow("string")
    .promotionTier(0)
    .publiclyAccessible(false)
    .tags(Map.of("string", "string"))
    .build());
Copy
examplecluster_instance_resource_resource_from_rdscluster_instance = aws.rds.ClusterInstance("exampleclusterInstanceResourceResourceFromRdsclusterInstance",
    cluster_identifier="string",
    instance_class="string",
    engine="string",
    identifier="string",
    auto_minor_version_upgrade=False,
    copy_tags_to_snapshot=False,
    custom_iam_instance_profile="string",
    db_parameter_group_name="string",
    db_subnet_group_name="string",
    availability_zone="string",
    engine_version="string",
    force_destroy=False,
    apply_immediately=False,
    identifier_prefix="string",
    ca_cert_identifier="string",
    monitoring_interval=0,
    monitoring_role_arn="string",
    performance_insights_enabled=False,
    performance_insights_kms_key_id="string",
    performance_insights_retention_period=0,
    preferred_backup_window="string",
    preferred_maintenance_window="string",
    promotion_tier=0,
    publicly_accessible=False,
    tags={
        "string": "string",
    })
Copy
const exampleclusterInstanceResourceResourceFromRdsclusterInstance = new aws.rds.ClusterInstance("exampleclusterInstanceResourceResourceFromRdsclusterInstance", {
    clusterIdentifier: "string",
    instanceClass: "string",
    engine: "string",
    identifier: "string",
    autoMinorVersionUpgrade: false,
    copyTagsToSnapshot: false,
    customIamInstanceProfile: "string",
    dbParameterGroupName: "string",
    dbSubnetGroupName: "string",
    availabilityZone: "string",
    engineVersion: "string",
    forceDestroy: false,
    applyImmediately: false,
    identifierPrefix: "string",
    caCertIdentifier: "string",
    monitoringInterval: 0,
    monitoringRoleArn: "string",
    performanceInsightsEnabled: false,
    performanceInsightsKmsKeyId: "string",
    performanceInsightsRetentionPeriod: 0,
    preferredBackupWindow: "string",
    preferredMaintenanceWindow: "string",
    promotionTier: 0,
    publiclyAccessible: false,
    tags: {
        string: "string",
    },
});
Copy
type: aws:rds:ClusterInstance
properties:
    applyImmediately: false
    autoMinorVersionUpgrade: false
    availabilityZone: string
    caCertIdentifier: string
    clusterIdentifier: string
    copyTagsToSnapshot: false
    customIamInstanceProfile: string
    dbParameterGroupName: string
    dbSubnetGroupName: string
    engine: string
    engineVersion: string
    forceDestroy: false
    identifier: string
    identifierPrefix: string
    instanceClass: string
    monitoringInterval: 0
    monitoringRoleArn: string
    performanceInsightsEnabled: false
    performanceInsightsKmsKeyId: string
    performanceInsightsRetentionPeriod: 0
    preferredBackupWindow: string
    preferredMaintenanceWindow: string
    promotionTier: 0
    publiclyAccessible: false
    tags:
        string: string
Copy

ClusterInstance Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ClusterInstance resource accepts the following input properties:

ClusterIdentifier
This property is required.
Changes to this property will trigger replacement.
string
Identifier of the aws.rds.Cluster in which to launch this instance.
Engine
This property is required.
Changes to this property will trigger replacement.
string
Name of the database engine to be used for the RDS cluster instance. Valid Values: aurora-mysql, aurora-postgresql, mysql, postgres.(Note that mysql and postgres are Multi-AZ RDS clusters).
InstanceClass This property is required. string | Pulumi.Aws.Rds.InstanceType
Instance class to use. For details on CPU and memory, see Scaling Aurora DB Instances. Aurora uses db.* instance classes/types. Please see AWS Documentation for currently available instance classes and complete details. For Aurora Serverless v2 use db.serverless.
ApplyImmediately bool
Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default isfalse.
AutoMinorVersionUpgrade bool
Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default true.
AvailabilityZone Changes to this property will trigger replacement. string
EC2 Availability Zone that the DB instance is created in. See docs about the details.
CaCertIdentifier string
Identifier of the CA certificate for the DB instance.
CopyTagsToSnapshot bool
Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance. Default false.
CustomIamInstanceProfile Changes to this property will trigger replacement. string
Instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
DbParameterGroupName string
Name of the DB parameter group to associate with this instance.
DbSubnetGroupName Changes to this property will trigger replacement. string
Specifies the DB subnet group to associate with this DB instance. The default behavior varies depending on whether db_subnet_group_name is specified. Please refer to official AWS documentation to understand how db_subnet_group_name and publicly_accessible parameters affect DB instance behaviour. NOTE: This must match the db_subnet_group_name of the attached aws.rds.Cluster.
EngineVersion string
Database engine version. Please note that to upgrade the engine_version of the instance, it must be done on the aws.rds.Cluster engine_version. Trying to upgrade in aws_cluster_instance will not update the engine_version.
ForceDestroy bool
Forces an instance to be destroyed when a part of a read replica cluster. Note: will promote the read replica to a standalone cluster before instance deletion.
Identifier Changes to this property will trigger replacement. string
Identifier for the RDS instance, if omitted, Pulumi will assign a random, unique identifier.
IdentifierPrefix Changes to this property will trigger replacement. string
Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
MonitoringInterval int
Interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
MonitoringRoleArn string
ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
PerformanceInsightsEnabled bool
Specifies whether Performance Insights is enabled or not. NOTE: When Performance Insights is configured at the cluster level through aws.rds.Cluster, this argument cannot be set to a value that conflicts with the cluster's configuration.
PerformanceInsightsKmsKeyId string
ARN for the KMS key to encrypt Performance Insights data. When specifying performance_insights_kms_key_id, performance_insights_enabled needs to be set to true.
PerformanceInsightsRetentionPeriod int
Amount of time in days to retain Performance Insights data. Valid values are 7, 731 (2 years) or a multiple of 31. When specifying performance_insights_retention_period, performance_insights_enabled needs to be set to true. Defaults to '7'.
PreferredBackupWindow string
Daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00". NOTE: If preferred_backup_window is set at the cluster level, this argument must be omitted.
PreferredMaintenanceWindow string
Window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
PromotionTier int
Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoted to writer.
PubliclyAccessible bool
Bool to control if instance is publicly accessible. Default false. See the documentation on Creating DB Instances for more details on controlling this property.
Tags Dictionary<string, string>
Map of tags to assign to the instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
ClusterIdentifier
This property is required.
Changes to this property will trigger replacement.
string
Identifier of the aws.rds.Cluster in which to launch this instance.
Engine
This property is required.
Changes to this property will trigger replacement.
string
Name of the database engine to be used for the RDS cluster instance. Valid Values: aurora-mysql, aurora-postgresql, mysql, postgres.(Note that mysql and postgres are Multi-AZ RDS clusters).
InstanceClass This property is required. string | InstanceType
Instance class to use. For details on CPU and memory, see Scaling Aurora DB Instances. Aurora uses db.* instance classes/types. Please see AWS Documentation for currently available instance classes and complete details. For Aurora Serverless v2 use db.serverless.
ApplyImmediately bool
Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default isfalse.
AutoMinorVersionUpgrade bool
Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default true.
AvailabilityZone Changes to this property will trigger replacement. string
EC2 Availability Zone that the DB instance is created in. See docs about the details.
CaCertIdentifier string
Identifier of the CA certificate for the DB instance.
CopyTagsToSnapshot bool
Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance. Default false.
CustomIamInstanceProfile Changes to this property will trigger replacement. string
Instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
DbParameterGroupName string
Name of the DB parameter group to associate with this instance.
DbSubnetGroupName Changes to this property will trigger replacement. string
Specifies the DB subnet group to associate with this DB instance. The default behavior varies depending on whether db_subnet_group_name is specified. Please refer to official AWS documentation to understand how db_subnet_group_name and publicly_accessible parameters affect DB instance behaviour. NOTE: This must match the db_subnet_group_name of the attached aws.rds.Cluster.
EngineVersion string
Database engine version. Please note that to upgrade the engine_version of the instance, it must be done on the aws.rds.Cluster engine_version. Trying to upgrade in aws_cluster_instance will not update the engine_version.
ForceDestroy bool
Forces an instance to be destroyed when a part of a read replica cluster. Note: will promote the read replica to a standalone cluster before instance deletion.
Identifier Changes to this property will trigger replacement. string
Identifier for the RDS instance, if omitted, Pulumi will assign a random, unique identifier.
IdentifierPrefix Changes to this property will trigger replacement. string
Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
MonitoringInterval int
Interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
MonitoringRoleArn string
ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
PerformanceInsightsEnabled bool
Specifies whether Performance Insights is enabled or not. NOTE: When Performance Insights is configured at the cluster level through aws.rds.Cluster, this argument cannot be set to a value that conflicts with the cluster's configuration.
PerformanceInsightsKmsKeyId string
ARN for the KMS key to encrypt Performance Insights data. When specifying performance_insights_kms_key_id, performance_insights_enabled needs to be set to true.
PerformanceInsightsRetentionPeriod int
Amount of time in days to retain Performance Insights data. Valid values are 7, 731 (2 years) or a multiple of 31. When specifying performance_insights_retention_period, performance_insights_enabled needs to be set to true. Defaults to '7'.
PreferredBackupWindow string
Daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00". NOTE: If preferred_backup_window is set at the cluster level, this argument must be omitted.
PreferredMaintenanceWindow string
Window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
PromotionTier int
Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoted to writer.
PubliclyAccessible bool
Bool to control if instance is publicly accessible. Default false. See the documentation on Creating DB Instances for more details on controlling this property.
Tags map[string]string
Map of tags to assign to the instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
clusterIdentifier
This property is required.
Changes to this property will trigger replacement.
String
Identifier of the aws.rds.Cluster in which to launch this instance.
engine
This property is required.
Changes to this property will trigger replacement.
String
Name of the database engine to be used for the RDS cluster instance. Valid Values: aurora-mysql, aurora-postgresql, mysql, postgres.(Note that mysql and postgres are Multi-AZ RDS clusters).
instanceClass This property is required. String | InstanceType
Instance class to use. For details on CPU and memory, see Scaling Aurora DB Instances. Aurora uses db.* instance classes/types. Please see AWS Documentation for currently available instance classes and complete details. For Aurora Serverless v2 use db.serverless.
applyImmediately Boolean
Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default isfalse.
autoMinorVersionUpgrade Boolean
Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default true.
availabilityZone Changes to this property will trigger replacement. String
EC2 Availability Zone that the DB instance is created in. See docs about the details.
caCertIdentifier String
Identifier of the CA certificate for the DB instance.
copyTagsToSnapshot Boolean
Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance. Default false.
customIamInstanceProfile Changes to this property will trigger replacement. String
Instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
dbParameterGroupName String
Name of the DB parameter group to associate with this instance.
dbSubnetGroupName Changes to this property will trigger replacement. String
Specifies the DB subnet group to associate with this DB instance. The default behavior varies depending on whether db_subnet_group_name is specified. Please refer to official AWS documentation to understand how db_subnet_group_name and publicly_accessible parameters affect DB instance behaviour. NOTE: This must match the db_subnet_group_name of the attached aws.rds.Cluster.
engineVersion String
Database engine version. Please note that to upgrade the engine_version of the instance, it must be done on the aws.rds.Cluster engine_version. Trying to upgrade in aws_cluster_instance will not update the engine_version.
forceDestroy Boolean
Forces an instance to be destroyed when a part of a read replica cluster. Note: will promote the read replica to a standalone cluster before instance deletion.
identifier Changes to this property will trigger replacement. String
Identifier for the RDS instance, if omitted, Pulumi will assign a random, unique identifier.
identifierPrefix Changes to this property will trigger replacement. String
Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
monitoringInterval Integer
Interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
monitoringRoleArn String
ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
performanceInsightsEnabled Boolean
Specifies whether Performance Insights is enabled or not. NOTE: When Performance Insights is configured at the cluster level through aws.rds.Cluster, this argument cannot be set to a value that conflicts with the cluster's configuration.
performanceInsightsKmsKeyId String
ARN for the KMS key to encrypt Performance Insights data. When specifying performance_insights_kms_key_id, performance_insights_enabled needs to be set to true.
performanceInsightsRetentionPeriod Integer
Amount of time in days to retain Performance Insights data. Valid values are 7, 731 (2 years) or a multiple of 31. When specifying performance_insights_retention_period, performance_insights_enabled needs to be set to true. Defaults to '7'.
preferredBackupWindow String
Daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00". NOTE: If preferred_backup_window is set at the cluster level, this argument must be omitted.
preferredMaintenanceWindow String
Window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
promotionTier Integer
Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoted to writer.
publiclyAccessible Boolean
Bool to control if instance is publicly accessible. Default false. See the documentation on Creating DB Instances for more details on controlling this property.
tags Map<String,String>
Map of tags to assign to the instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
clusterIdentifier
This property is required.
Changes to this property will trigger replacement.
string
Identifier of the aws.rds.Cluster in which to launch this instance.
engine
This property is required.
Changes to this property will trigger replacement.
EngineType
Name of the database engine to be used for the RDS cluster instance. Valid Values: aurora-mysql, aurora-postgresql, mysql, postgres.(Note that mysql and postgres are Multi-AZ RDS clusters).
instanceClass This property is required. string | InstanceType
Instance class to use. For details on CPU and memory, see Scaling Aurora DB Instances. Aurora uses db.* instance classes/types. Please see AWS Documentation for currently available instance classes and complete details. For Aurora Serverless v2 use db.serverless.
applyImmediately boolean
Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default isfalse.
autoMinorVersionUpgrade boolean
Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default true.
availabilityZone Changes to this property will trigger replacement. string
EC2 Availability Zone that the DB instance is created in. See docs about the details.
caCertIdentifier string
Identifier of the CA certificate for the DB instance.
copyTagsToSnapshot boolean
Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance. Default false.
customIamInstanceProfile Changes to this property will trigger replacement. string
Instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
dbParameterGroupName string
Name of the DB parameter group to associate with this instance.
dbSubnetGroupName Changes to this property will trigger replacement. string
Specifies the DB subnet group to associate with this DB instance. The default behavior varies depending on whether db_subnet_group_name is specified. Please refer to official AWS documentation to understand how db_subnet_group_name and publicly_accessible parameters affect DB instance behaviour. NOTE: This must match the db_subnet_group_name of the attached aws.rds.Cluster.
engineVersion string
Database engine version. Please note that to upgrade the engine_version of the instance, it must be done on the aws.rds.Cluster engine_version. Trying to upgrade in aws_cluster_instance will not update the engine_version.
forceDestroy boolean
Forces an instance to be destroyed when a part of a read replica cluster. Note: will promote the read replica to a standalone cluster before instance deletion.
identifier Changes to this property will trigger replacement. string
Identifier for the RDS instance, if omitted, Pulumi will assign a random, unique identifier.
identifierPrefix Changes to this property will trigger replacement. string
Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
monitoringInterval number
Interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
monitoringRoleArn string
ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
performanceInsightsEnabled boolean
Specifies whether Performance Insights is enabled or not. NOTE: When Performance Insights is configured at the cluster level through aws.rds.Cluster, this argument cannot be set to a value that conflicts with the cluster's configuration.
performanceInsightsKmsKeyId string
ARN for the KMS key to encrypt Performance Insights data. When specifying performance_insights_kms_key_id, performance_insights_enabled needs to be set to true.
performanceInsightsRetentionPeriod number
Amount of time in days to retain Performance Insights data. Valid values are 7, 731 (2 years) or a multiple of 31. When specifying performance_insights_retention_period, performance_insights_enabled needs to be set to true. Defaults to '7'.
preferredBackupWindow string
Daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00". NOTE: If preferred_backup_window is set at the cluster level, this argument must be omitted.
preferredMaintenanceWindow string
Window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
promotionTier number
Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoted to writer.
publiclyAccessible boolean
Bool to control if instance is publicly accessible. Default false. See the documentation on Creating DB Instances for more details on controlling this property.
tags {[key: string]: string}
Map of tags to assign to the instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
cluster_identifier
This property is required.
Changes to this property will trigger replacement.
str
Identifier of the aws.rds.Cluster in which to launch this instance.
engine
This property is required.
Changes to this property will trigger replacement.
str
Name of the database engine to be used for the RDS cluster instance. Valid Values: aurora-mysql, aurora-postgresql, mysql, postgres.(Note that mysql and postgres are Multi-AZ RDS clusters).
instance_class This property is required. str | InstanceType
Instance class to use. For details on CPU and memory, see Scaling Aurora DB Instances. Aurora uses db.* instance classes/types. Please see AWS Documentation for currently available instance classes and complete details. For Aurora Serverless v2 use db.serverless.
apply_immediately bool
Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default isfalse.
auto_minor_version_upgrade bool
Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default true.
availability_zone Changes to this property will trigger replacement. str
EC2 Availability Zone that the DB instance is created in. See docs about the details.
ca_cert_identifier str
Identifier of the CA certificate for the DB instance.
copy_tags_to_snapshot bool
Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance. Default false.
custom_iam_instance_profile Changes to this property will trigger replacement. str
Instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
db_parameter_group_name str
Name of the DB parameter group to associate with this instance.
db_subnet_group_name Changes to this property will trigger replacement. str
Specifies the DB subnet group to associate with this DB instance. The default behavior varies depending on whether db_subnet_group_name is specified. Please refer to official AWS documentation to understand how db_subnet_group_name and publicly_accessible parameters affect DB instance behaviour. NOTE: This must match the db_subnet_group_name of the attached aws.rds.Cluster.
engine_version str
Database engine version. Please note that to upgrade the engine_version of the instance, it must be done on the aws.rds.Cluster engine_version. Trying to upgrade in aws_cluster_instance will not update the engine_version.
force_destroy bool
Forces an instance to be destroyed when a part of a read replica cluster. Note: will promote the read replica to a standalone cluster before instance deletion.
identifier Changes to this property will trigger replacement. str
Identifier for the RDS instance, if omitted, Pulumi will assign a random, unique identifier.
identifier_prefix Changes to this property will trigger replacement. str
Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
monitoring_interval int
Interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
monitoring_role_arn str
ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
performance_insights_enabled bool
Specifies whether Performance Insights is enabled or not. NOTE: When Performance Insights is configured at the cluster level through aws.rds.Cluster, this argument cannot be set to a value that conflicts with the cluster's configuration.
performance_insights_kms_key_id str
ARN for the KMS key to encrypt Performance Insights data. When specifying performance_insights_kms_key_id, performance_insights_enabled needs to be set to true.
performance_insights_retention_period int
Amount of time in days to retain Performance Insights data. Valid values are 7, 731 (2 years) or a multiple of 31. When specifying performance_insights_retention_period, performance_insights_enabled needs to be set to true. Defaults to '7'.
preferred_backup_window str
Daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00". NOTE: If preferred_backup_window is set at the cluster level, this argument must be omitted.
preferred_maintenance_window str
Window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
promotion_tier int
Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoted to writer.
publicly_accessible bool
Bool to control if instance is publicly accessible. Default false. See the documentation on Creating DB Instances for more details on controlling this property.
tags Mapping[str, str]
Map of tags to assign to the instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
clusterIdentifier
This property is required.
Changes to this property will trigger replacement.
String
Identifier of the aws.rds.Cluster in which to launch this instance.
engine
This property is required.
Changes to this property will trigger replacement.
Name of the database engine to be used for the RDS cluster instance. Valid Values: aurora-mysql, aurora-postgresql, mysql, postgres.(Note that mysql and postgres are Multi-AZ RDS clusters).
instanceClass This property is required. String | "db.t4g.micro" | "db.t4g.small" | "db.t4g.medium" | "db.t4g.large" | "db.t4g.xlarge" | "db.t4g.2xlarge" | "db.t3.micro" | "db.t3.small" | "db.t3.medium" | "db.t3.large" | "db.t3.xlarge" | "db.t3.2xlarge" | "db.t2.micro" | "db.t2.small" | "db.t2.medium" | "db.t2.large" | "db.t2.xlarge" | "db.t2.2xlarge" | "db.m1.small" | "db.m1.medium" | "db.m1.large" | "db.m1.xlarge" | "db.m2.xlarge" | "db.m2.2xlarge" | "db.m2.4xlarge" | "db.m3.medium" | "db.m3.large" | "db.m3.xlarge" | "db.m3.2xlarge" | "db.m4.large" | "db.m4.xlarge" | "db.m4.2xlarge" | "db.m4.4xlarge" | "db.m4.10xlarge" | "db.m4.10xlarge" | "db.m5.large" | "db.m5.xlarge" | "db.m5.2xlarge" | "db.m5.4xlarge" | "db.m5.12xlarge" | "db.m5.24xlarge" | "db.m6g.large" | "db.m6g.xlarge" | "db.m6g.2xlarge" | "db.m6g.4xlarge" | "db.m6g.8xlarge" | "db.m6g.12xlarge" | "db.m6g.16xlarge" | "db.r3.large" | "db.r3.xlarge" | "db.r3.2xlarge" | "db.r3.4xlarge" | "db.r3.8xlarge" | "db.r4.large" | "db.r4.xlarge" | "db.r4.2xlarge" | "db.r4.4xlarge" | "db.r4.8xlarge" | "db.r4.16xlarge" | "db.r5.large" | "db.r5.xlarge" | "db.r5.2xlarge" | "db.r5.4xlarge" | "db.r5.12xlarge" | "db.r5.24xlarge" | "db.r6g.large" | "db.r6g.xlarge" | "db.r6g.2xlarge" | "db.r6g.4xlarge" | "db.r6g.8xlarge" | "db.r6g.12xlarge" | "db.r6g.16xlarge" | "db.x1.16xlarge" | "db.x1.32xlarge" | "db.x1e.xlarge" | "db.x1e.2xlarge" | "db.x1e.4xlarge" | "db.x1e.8xlarge" | "db.x1e.32xlarge"
Instance class to use. For details on CPU and memory, see Scaling Aurora DB Instances. Aurora uses db.* instance classes/types. Please see AWS Documentation for currently available instance classes and complete details. For Aurora Serverless v2 use db.serverless.
applyImmediately Boolean
Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default isfalse.
autoMinorVersionUpgrade Boolean
Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default true.
availabilityZone Changes to this property will trigger replacement. String
EC2 Availability Zone that the DB instance is created in. See docs about the details.
caCertIdentifier String
Identifier of the CA certificate for the DB instance.
copyTagsToSnapshot Boolean
Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance. Default false.
customIamInstanceProfile Changes to this property will trigger replacement. String
Instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
dbParameterGroupName String
Name of the DB parameter group to associate with this instance.
dbSubnetGroupName Changes to this property will trigger replacement. String
Specifies the DB subnet group to associate with this DB instance. The default behavior varies depending on whether db_subnet_group_name is specified. Please refer to official AWS documentation to understand how db_subnet_group_name and publicly_accessible parameters affect DB instance behaviour. NOTE: This must match the db_subnet_group_name of the attached aws.rds.Cluster.
engineVersion String
Database engine version. Please note that to upgrade the engine_version of the instance, it must be done on the aws.rds.Cluster engine_version. Trying to upgrade in aws_cluster_instance will not update the engine_version.
forceDestroy Boolean
Forces an instance to be destroyed when a part of a read replica cluster. Note: will promote the read replica to a standalone cluster before instance deletion.
identifier Changes to this property will trigger replacement. String
Identifier for the RDS instance, if omitted, Pulumi will assign a random, unique identifier.
identifierPrefix Changes to this property will trigger replacement. String
Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
monitoringInterval Number
Interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
monitoringRoleArn String
ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
performanceInsightsEnabled Boolean
Specifies whether Performance Insights is enabled or not. NOTE: When Performance Insights is configured at the cluster level through aws.rds.Cluster, this argument cannot be set to a value that conflicts with the cluster's configuration.
performanceInsightsKmsKeyId String
ARN for the KMS key to encrypt Performance Insights data. When specifying performance_insights_kms_key_id, performance_insights_enabled needs to be set to true.
performanceInsightsRetentionPeriod Number
Amount of time in days to retain Performance Insights data. Valid values are 7, 731 (2 years) or a multiple of 31. When specifying performance_insights_retention_period, performance_insights_enabled needs to be set to true. Defaults to '7'.
preferredBackupWindow String
Daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00". NOTE: If preferred_backup_window is set at the cluster level, this argument must be omitted.
preferredMaintenanceWindow String
Window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
promotionTier Number
Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoted to writer.
publiclyAccessible Boolean
Bool to control if instance is publicly accessible. Default false. See the documentation on Creating DB Instances for more details on controlling this property.
tags Map<String>
Map of tags to assign to the instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Outputs

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

Arn string
Amazon Resource Name (ARN) of cluster instance
DbiResourceId string
Region-unique, immutable identifier for the DB instance.
Endpoint string
DNS address for this instance. May not be writable
EngineVersionActual string
Database engine version
Id string
The provider-assigned unique ID for this managed resource.
KmsKeyId string
ARN for the KMS encryption key if one is set to the cluster.
NetworkType string
Network type of the DB instance.
Port int
Database port
StorageEncrypted bool
Specifies whether the DB cluster is encrypted.
TagsAll Dictionary<string, string>
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Writer bool
Boolean indicating if this instance is writable. False indicates this instance is a read replica.
Arn string
Amazon Resource Name (ARN) of cluster instance
DbiResourceId string
Region-unique, immutable identifier for the DB instance.
Endpoint string
DNS address for this instance. May not be writable
EngineVersionActual string
Database engine version
Id string
The provider-assigned unique ID for this managed resource.
KmsKeyId string
ARN for the KMS encryption key if one is set to the cluster.
NetworkType string
Network type of the DB instance.
Port int
Database port
StorageEncrypted bool
Specifies whether the DB cluster is encrypted.
TagsAll map[string]string
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Writer bool
Boolean indicating if this instance is writable. False indicates this instance is a read replica.
arn String
Amazon Resource Name (ARN) of cluster instance
dbiResourceId String
Region-unique, immutable identifier for the DB instance.
endpoint String
DNS address for this instance. May not be writable
engineVersionActual String
Database engine version
id String
The provider-assigned unique ID for this managed resource.
kmsKeyId String
ARN for the KMS encryption key if one is set to the cluster.
networkType String
Network type of the DB instance.
port Integer
Database port
storageEncrypted Boolean
Specifies whether the DB cluster is encrypted.
tagsAll Map<String,String>
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

writer Boolean
Boolean indicating if this instance is writable. False indicates this instance is a read replica.
arn string
Amazon Resource Name (ARN) of cluster instance
dbiResourceId string
Region-unique, immutable identifier for the DB instance.
endpoint string
DNS address for this instance. May not be writable
engineVersionActual string
Database engine version
id string
The provider-assigned unique ID for this managed resource.
kmsKeyId string
ARN for the KMS encryption key if one is set to the cluster.
networkType string
Network type of the DB instance.
port number
Database port
storageEncrypted boolean
Specifies whether the DB cluster is encrypted.
tagsAll {[key: string]: string}
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

writer boolean
Boolean indicating if this instance is writable. False indicates this instance is a read replica.
arn str
Amazon Resource Name (ARN) of cluster instance
dbi_resource_id str
Region-unique, immutable identifier for the DB instance.
endpoint str
DNS address for this instance. May not be writable
engine_version_actual str
Database engine version
id str
The provider-assigned unique ID for this managed resource.
kms_key_id str
ARN for the KMS encryption key if one is set to the cluster.
network_type str
Network type of the DB instance.
port int
Database port
storage_encrypted bool
Specifies whether the DB cluster is encrypted.
tags_all Mapping[str, str]
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

writer bool
Boolean indicating if this instance is writable. False indicates this instance is a read replica.
arn String
Amazon Resource Name (ARN) of cluster instance
dbiResourceId String
Region-unique, immutable identifier for the DB instance.
endpoint String
DNS address for this instance. May not be writable
engineVersionActual String
Database engine version
id String
The provider-assigned unique ID for this managed resource.
kmsKeyId String
ARN for the KMS encryption key if one is set to the cluster.
networkType String
Network type of the DB instance.
port Number
Database port
storageEncrypted Boolean
Specifies whether the DB cluster is encrypted.
tagsAll Map<String>
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

writer Boolean
Boolean indicating if this instance is writable. False indicates this instance is a read replica.

Look up Existing ClusterInstance Resource

Get an existing ClusterInstance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ClusterInstanceState, opts?: CustomResourceOptions): ClusterInstance
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        apply_immediately: Optional[bool] = None,
        arn: Optional[str] = None,
        auto_minor_version_upgrade: Optional[bool] = None,
        availability_zone: Optional[str] = None,
        ca_cert_identifier: Optional[str] = None,
        cluster_identifier: Optional[str] = None,
        copy_tags_to_snapshot: Optional[bool] = None,
        custom_iam_instance_profile: Optional[str] = None,
        db_parameter_group_name: Optional[str] = None,
        db_subnet_group_name: Optional[str] = None,
        dbi_resource_id: Optional[str] = None,
        endpoint: Optional[str] = None,
        engine: Optional[str] = None,
        engine_version: Optional[str] = None,
        engine_version_actual: Optional[str] = None,
        force_destroy: Optional[bool] = None,
        identifier: Optional[str] = None,
        identifier_prefix: Optional[str] = None,
        instance_class: Optional[Union[str, InstanceType]] = None,
        kms_key_id: Optional[str] = None,
        monitoring_interval: Optional[int] = None,
        monitoring_role_arn: Optional[str] = None,
        network_type: 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,
        promotion_tier: Optional[int] = None,
        publicly_accessible: Optional[bool] = None,
        storage_encrypted: Optional[bool] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        writer: Optional[bool] = None) -> ClusterInstance
func GetClusterInstance(ctx *Context, name string, id IDInput, state *ClusterInstanceState, opts ...ResourceOption) (*ClusterInstance, error)
public static ClusterInstance Get(string name, Input<string> id, ClusterInstanceState? state, CustomResourceOptions? opts = null)
public static ClusterInstance get(String name, Output<String> id, ClusterInstanceState state, CustomResourceOptions options)
resources:  _:    type: aws:rds:ClusterInstance    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.
The following state arguments are supported:
ApplyImmediately bool
Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default isfalse.
Arn string
Amazon Resource Name (ARN) of cluster instance
AutoMinorVersionUpgrade bool
Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default true.
AvailabilityZone Changes to this property will trigger replacement. string
EC2 Availability Zone that the DB instance is created in. See docs about the details.
CaCertIdentifier string
Identifier of the CA certificate for the DB instance.
ClusterIdentifier Changes to this property will trigger replacement. string
Identifier of the aws.rds.Cluster in which to launch this instance.
CopyTagsToSnapshot bool
Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance. Default false.
CustomIamInstanceProfile Changes to this property will trigger replacement. string
Instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
DbParameterGroupName string
Name of the DB parameter group to associate with this instance.
DbSubnetGroupName Changes to this property will trigger replacement. string
Specifies the DB subnet group to associate with this DB instance. The default behavior varies depending on whether db_subnet_group_name is specified. Please refer to official AWS documentation to understand how db_subnet_group_name and publicly_accessible parameters affect DB instance behaviour. NOTE: This must match the db_subnet_group_name of the attached aws.rds.Cluster.
DbiResourceId string
Region-unique, immutable identifier for the DB instance.
Endpoint string
DNS address for this instance. May not be writable
Engine Changes to this property will trigger replacement. string
Name of the database engine to be used for the RDS cluster instance. Valid Values: aurora-mysql, aurora-postgresql, mysql, postgres.(Note that mysql and postgres are Multi-AZ RDS clusters).
EngineVersion string
Database engine version. Please note that to upgrade the engine_version of the instance, it must be done on the aws.rds.Cluster engine_version. Trying to upgrade in aws_cluster_instance will not update the engine_version.
EngineVersionActual string
Database engine version
ForceDestroy bool
Forces an instance to be destroyed when a part of a read replica cluster. Note: will promote the read replica to a standalone cluster before instance deletion.
Identifier Changes to this property will trigger replacement. string
Identifier for the RDS instance, if omitted, Pulumi will assign a random, unique identifier.
IdentifierPrefix Changes to this property will trigger replacement. string
Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
InstanceClass string | Pulumi.Aws.Rds.InstanceType
Instance class to use. For details on CPU and memory, see Scaling Aurora DB Instances. Aurora uses db.* instance classes/types. Please see AWS Documentation for currently available instance classes and complete details. For Aurora Serverless v2 use db.serverless.
KmsKeyId string
ARN for the KMS encryption key if one is set to the cluster.
MonitoringInterval int
Interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
MonitoringRoleArn string
ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
NetworkType string
Network type of the DB instance.
PerformanceInsightsEnabled bool
Specifies whether Performance Insights is enabled or not. NOTE: When Performance Insights is configured at the cluster level through aws.rds.Cluster, this argument cannot be set to a value that conflicts with the cluster's configuration.
PerformanceInsightsKmsKeyId string
ARN for the KMS key to encrypt Performance Insights data. When specifying performance_insights_kms_key_id, performance_insights_enabled needs to be set to true.
PerformanceInsightsRetentionPeriod int
Amount of time in days to retain Performance Insights data. Valid values are 7, 731 (2 years) or a multiple of 31. When specifying performance_insights_retention_period, performance_insights_enabled needs to be set to true. Defaults to '7'.
Port int
Database port
PreferredBackupWindow string
Daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00". NOTE: If preferred_backup_window is set at the cluster level, this argument must be omitted.
PreferredMaintenanceWindow string
Window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
PromotionTier int
Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoted to writer.
PubliclyAccessible bool
Bool to control if instance is publicly accessible. Default false. See the documentation on Creating DB Instances for more details on controlling this property.
StorageEncrypted bool
Specifies whether the DB cluster is encrypted.
Tags Dictionary<string, string>
Map of tags to assign to the instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll Dictionary<string, string>
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Writer bool
Boolean indicating if this instance is writable. False indicates this instance is a read replica.
ApplyImmediately bool
Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default isfalse.
Arn string
Amazon Resource Name (ARN) of cluster instance
AutoMinorVersionUpgrade bool
Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default true.
AvailabilityZone Changes to this property will trigger replacement. string
EC2 Availability Zone that the DB instance is created in. See docs about the details.
CaCertIdentifier string
Identifier of the CA certificate for the DB instance.
ClusterIdentifier Changes to this property will trigger replacement. string
Identifier of the aws.rds.Cluster in which to launch this instance.
CopyTagsToSnapshot bool
Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance. Default false.
CustomIamInstanceProfile Changes to this property will trigger replacement. string
Instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
DbParameterGroupName string
Name of the DB parameter group to associate with this instance.
DbSubnetGroupName Changes to this property will trigger replacement. string
Specifies the DB subnet group to associate with this DB instance. The default behavior varies depending on whether db_subnet_group_name is specified. Please refer to official AWS documentation to understand how db_subnet_group_name and publicly_accessible parameters affect DB instance behaviour. NOTE: This must match the db_subnet_group_name of the attached aws.rds.Cluster.
DbiResourceId string
Region-unique, immutable identifier for the DB instance.
Endpoint string
DNS address for this instance. May not be writable
Engine Changes to this property will trigger replacement. string
Name of the database engine to be used for the RDS cluster instance. Valid Values: aurora-mysql, aurora-postgresql, mysql, postgres.(Note that mysql and postgres are Multi-AZ RDS clusters).
EngineVersion string
Database engine version. Please note that to upgrade the engine_version of the instance, it must be done on the aws.rds.Cluster engine_version. Trying to upgrade in aws_cluster_instance will not update the engine_version.
EngineVersionActual string
Database engine version
ForceDestroy bool
Forces an instance to be destroyed when a part of a read replica cluster. Note: will promote the read replica to a standalone cluster before instance deletion.
Identifier Changes to this property will trigger replacement. string
Identifier for the RDS instance, if omitted, Pulumi will assign a random, unique identifier.
IdentifierPrefix Changes to this property will trigger replacement. string
Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
InstanceClass string | InstanceType
Instance class to use. For details on CPU and memory, see Scaling Aurora DB Instances. Aurora uses db.* instance classes/types. Please see AWS Documentation for currently available instance classes and complete details. For Aurora Serverless v2 use db.serverless.
KmsKeyId string
ARN for the KMS encryption key if one is set to the cluster.
MonitoringInterval int
Interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
MonitoringRoleArn string
ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
NetworkType string
Network type of the DB instance.
PerformanceInsightsEnabled bool
Specifies whether Performance Insights is enabled or not. NOTE: When Performance Insights is configured at the cluster level through aws.rds.Cluster, this argument cannot be set to a value that conflicts with the cluster's configuration.
PerformanceInsightsKmsKeyId string
ARN for the KMS key to encrypt Performance Insights data. When specifying performance_insights_kms_key_id, performance_insights_enabled needs to be set to true.
PerformanceInsightsRetentionPeriod int
Amount of time in days to retain Performance Insights data. Valid values are 7, 731 (2 years) or a multiple of 31. When specifying performance_insights_retention_period, performance_insights_enabled needs to be set to true. Defaults to '7'.
Port int
Database port
PreferredBackupWindow string
Daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00". NOTE: If preferred_backup_window is set at the cluster level, this argument must be omitted.
PreferredMaintenanceWindow string
Window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
PromotionTier int
Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoted to writer.
PubliclyAccessible bool
Bool to control if instance is publicly accessible. Default false. See the documentation on Creating DB Instances for more details on controlling this property.
StorageEncrypted bool
Specifies whether the DB cluster is encrypted.
Tags map[string]string
Map of tags to assign to the instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll map[string]string
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Writer bool
Boolean indicating if this instance is writable. False indicates this instance is a read replica.
applyImmediately Boolean
Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default isfalse.
arn String
Amazon Resource Name (ARN) of cluster instance
autoMinorVersionUpgrade Boolean
Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default true.
availabilityZone Changes to this property will trigger replacement. String
EC2 Availability Zone that the DB instance is created in. See docs about the details.
caCertIdentifier String
Identifier of the CA certificate for the DB instance.
clusterIdentifier Changes to this property will trigger replacement. String
Identifier of the aws.rds.Cluster in which to launch this instance.
copyTagsToSnapshot Boolean
Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance. Default false.
customIamInstanceProfile Changes to this property will trigger replacement. String
Instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
dbParameterGroupName String
Name of the DB parameter group to associate with this instance.
dbSubnetGroupName Changes to this property will trigger replacement. String
Specifies the DB subnet group to associate with this DB instance. The default behavior varies depending on whether db_subnet_group_name is specified. Please refer to official AWS documentation to understand how db_subnet_group_name and publicly_accessible parameters affect DB instance behaviour. NOTE: This must match the db_subnet_group_name of the attached aws.rds.Cluster.
dbiResourceId String
Region-unique, immutable identifier for the DB instance.
endpoint String
DNS address for this instance. May not be writable
engine Changes to this property will trigger replacement. String
Name of the database engine to be used for the RDS cluster instance. Valid Values: aurora-mysql, aurora-postgresql, mysql, postgres.(Note that mysql and postgres are Multi-AZ RDS clusters).
engineVersion String
Database engine version. Please note that to upgrade the engine_version of the instance, it must be done on the aws.rds.Cluster engine_version. Trying to upgrade in aws_cluster_instance will not update the engine_version.
engineVersionActual String
Database engine version
forceDestroy Boolean
Forces an instance to be destroyed when a part of a read replica cluster. Note: will promote the read replica to a standalone cluster before instance deletion.
identifier Changes to this property will trigger replacement. String
Identifier for the RDS instance, if omitted, Pulumi will assign a random, unique identifier.
identifierPrefix Changes to this property will trigger replacement. String
Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
instanceClass String | InstanceType
Instance class to use. For details on CPU and memory, see Scaling Aurora DB Instances. Aurora uses db.* instance classes/types. Please see AWS Documentation for currently available instance classes and complete details. For Aurora Serverless v2 use db.serverless.
kmsKeyId String
ARN for the KMS encryption key if one is set to the cluster.
monitoringInterval Integer
Interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
monitoringRoleArn String
ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
networkType String
Network type of the DB instance.
performanceInsightsEnabled Boolean
Specifies whether Performance Insights is enabled or not. NOTE: When Performance Insights is configured at the cluster level through aws.rds.Cluster, this argument cannot be set to a value that conflicts with the cluster's configuration.
performanceInsightsKmsKeyId String
ARN for the KMS key to encrypt Performance Insights data. When specifying performance_insights_kms_key_id, performance_insights_enabled needs to be set to true.
performanceInsightsRetentionPeriod Integer
Amount of time in days to retain Performance Insights data. Valid values are 7, 731 (2 years) or a multiple of 31. When specifying performance_insights_retention_period, performance_insights_enabled needs to be set to true. Defaults to '7'.
port Integer
Database port
preferredBackupWindow String
Daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00". NOTE: If preferred_backup_window is set at the cluster level, this argument must be omitted.
preferredMaintenanceWindow String
Window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
promotionTier Integer
Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoted to writer.
publiclyAccessible Boolean
Bool to control if instance is publicly accessible. Default false. See the documentation on Creating DB Instances for more details on controlling this property.
storageEncrypted Boolean
Specifies whether the DB cluster is encrypted.
tags Map<String,String>
Map of tags to assign to the instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String,String>
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

writer Boolean
Boolean indicating if this instance is writable. False indicates this instance is a read replica.
applyImmediately boolean
Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default isfalse.
arn string
Amazon Resource Name (ARN) of cluster instance
autoMinorVersionUpgrade boolean
Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default true.
availabilityZone Changes to this property will trigger replacement. string
EC2 Availability Zone that the DB instance is created in. See docs about the details.
caCertIdentifier string
Identifier of the CA certificate for the DB instance.
clusterIdentifier Changes to this property will trigger replacement. string
Identifier of the aws.rds.Cluster in which to launch this instance.
copyTagsToSnapshot boolean
Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance. Default false.
customIamInstanceProfile Changes to this property will trigger replacement. string
Instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
dbParameterGroupName string
Name of the DB parameter group to associate with this instance.
dbSubnetGroupName Changes to this property will trigger replacement. string
Specifies the DB subnet group to associate with this DB instance. The default behavior varies depending on whether db_subnet_group_name is specified. Please refer to official AWS documentation to understand how db_subnet_group_name and publicly_accessible parameters affect DB instance behaviour. NOTE: This must match the db_subnet_group_name of the attached aws.rds.Cluster.
dbiResourceId string
Region-unique, immutable identifier for the DB instance.
endpoint string
DNS address for this instance. May not be writable
engine Changes to this property will trigger replacement. EngineType
Name of the database engine to be used for the RDS cluster instance. Valid Values: aurora-mysql, aurora-postgresql, mysql, postgres.(Note that mysql and postgres are Multi-AZ RDS clusters).
engineVersion string
Database engine version. Please note that to upgrade the engine_version of the instance, it must be done on the aws.rds.Cluster engine_version. Trying to upgrade in aws_cluster_instance will not update the engine_version.
engineVersionActual string
Database engine version
forceDestroy boolean
Forces an instance to be destroyed when a part of a read replica cluster. Note: will promote the read replica to a standalone cluster before instance deletion.
identifier Changes to this property will trigger replacement. string
Identifier for the RDS instance, if omitted, Pulumi will assign a random, unique identifier.
identifierPrefix Changes to this property will trigger replacement. string
Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
instanceClass string | InstanceType
Instance class to use. For details on CPU and memory, see Scaling Aurora DB Instances. Aurora uses db.* instance classes/types. Please see AWS Documentation for currently available instance classes and complete details. For Aurora Serverless v2 use db.serverless.
kmsKeyId string
ARN for the KMS encryption key if one is set to the cluster.
monitoringInterval number
Interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
monitoringRoleArn string
ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
networkType string
Network type of the DB instance.
performanceInsightsEnabled boolean
Specifies whether Performance Insights is enabled or not. NOTE: When Performance Insights is configured at the cluster level through aws.rds.Cluster, this argument cannot be set to a value that conflicts with the cluster's configuration.
performanceInsightsKmsKeyId string
ARN for the KMS key to encrypt Performance Insights data. When specifying performance_insights_kms_key_id, performance_insights_enabled needs to be set to true.
performanceInsightsRetentionPeriod number
Amount of time in days to retain Performance Insights data. Valid values are 7, 731 (2 years) or a multiple of 31. When specifying performance_insights_retention_period, performance_insights_enabled needs to be set to true. Defaults to '7'.
port number
Database port
preferredBackupWindow string
Daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00". NOTE: If preferred_backup_window is set at the cluster level, this argument must be omitted.
preferredMaintenanceWindow string
Window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
promotionTier number
Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoted to writer.
publiclyAccessible boolean
Bool to control if instance is publicly accessible. Default false. See the documentation on Creating DB Instances for more details on controlling this property.
storageEncrypted boolean
Specifies whether the DB cluster is encrypted.
tags {[key: string]: string}
Map of tags to assign to the instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll {[key: string]: string}
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

writer boolean
Boolean indicating if this instance is writable. False indicates this instance is a read replica.
apply_immediately bool
Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default isfalse.
arn str
Amazon Resource Name (ARN) of cluster instance
auto_minor_version_upgrade bool
Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default true.
availability_zone Changes to this property will trigger replacement. str
EC2 Availability Zone that the DB instance is created in. See docs about the details.
ca_cert_identifier str
Identifier of the CA certificate for the DB instance.
cluster_identifier Changes to this property will trigger replacement. str
Identifier of the aws.rds.Cluster in which to launch this instance.
copy_tags_to_snapshot bool
Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance. Default false.
custom_iam_instance_profile Changes to this property will trigger replacement. str
Instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
db_parameter_group_name str
Name of the DB parameter group to associate with this instance.
db_subnet_group_name Changes to this property will trigger replacement. str
Specifies the DB subnet group to associate with this DB instance. The default behavior varies depending on whether db_subnet_group_name is specified. Please refer to official AWS documentation to understand how db_subnet_group_name and publicly_accessible parameters affect DB instance behaviour. NOTE: This must match the db_subnet_group_name of the attached aws.rds.Cluster.
dbi_resource_id str
Region-unique, immutable identifier for the DB instance.
endpoint str
DNS address for this instance. May not be writable
engine Changes to this property will trigger replacement. str
Name of the database engine to be used for the RDS cluster instance. Valid Values: aurora-mysql, aurora-postgresql, mysql, postgres.(Note that mysql and postgres are Multi-AZ RDS clusters).
engine_version str
Database engine version. Please note that to upgrade the engine_version of the instance, it must be done on the aws.rds.Cluster engine_version. Trying to upgrade in aws_cluster_instance will not update the engine_version.
engine_version_actual str
Database engine version
force_destroy bool
Forces an instance to be destroyed when a part of a read replica cluster. Note: will promote the read replica to a standalone cluster before instance deletion.
identifier Changes to this property will trigger replacement. str
Identifier for the RDS instance, if omitted, Pulumi will assign a random, unique identifier.
identifier_prefix Changes to this property will trigger replacement. str
Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
instance_class str | InstanceType
Instance class to use. For details on CPU and memory, see Scaling Aurora DB Instances. Aurora uses db.* instance classes/types. Please see AWS Documentation for currently available instance classes and complete details. For Aurora Serverless v2 use db.serverless.
kms_key_id str
ARN for the KMS encryption key if one is set to the cluster.
monitoring_interval int
Interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
monitoring_role_arn str
ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
network_type str
Network type of the DB instance.
performance_insights_enabled bool
Specifies whether Performance Insights is enabled or not. NOTE: When Performance Insights is configured at the cluster level through aws.rds.Cluster, this argument cannot be set to a value that conflicts with the cluster's configuration.
performance_insights_kms_key_id str
ARN for the KMS key to encrypt Performance Insights data. When specifying performance_insights_kms_key_id, performance_insights_enabled needs to be set to true.
performance_insights_retention_period int
Amount of time in days to retain Performance Insights data. Valid values are 7, 731 (2 years) or a multiple of 31. When specifying performance_insights_retention_period, performance_insights_enabled needs to be set to true. Defaults to '7'.
port int
Database port
preferred_backup_window str
Daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00". NOTE: If preferred_backup_window is set at the cluster level, this argument must be omitted.
preferred_maintenance_window str
Window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
promotion_tier int
Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoted to writer.
publicly_accessible bool
Bool to control if instance is publicly accessible. Default false. See the documentation on Creating DB Instances for more details on controlling this property.
storage_encrypted bool
Specifies whether the DB cluster is encrypted.
tags Mapping[str, str]
Map of tags to assign to the instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tags_all Mapping[str, str]
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

writer bool
Boolean indicating if this instance is writable. False indicates this instance is a read replica.
applyImmediately Boolean
Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default isfalse.
arn String
Amazon Resource Name (ARN) of cluster instance
autoMinorVersionUpgrade Boolean
Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default true.
availabilityZone Changes to this property will trigger replacement. String
EC2 Availability Zone that the DB instance is created in. See docs about the details.
caCertIdentifier String
Identifier of the CA certificate for the DB instance.
clusterIdentifier Changes to this property will trigger replacement. String
Identifier of the aws.rds.Cluster in which to launch this instance.
copyTagsToSnapshot Boolean
Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance. Default false.
customIamInstanceProfile Changes to this property will trigger replacement. String
Instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
dbParameterGroupName String
Name of the DB parameter group to associate with this instance.
dbSubnetGroupName Changes to this property will trigger replacement. String
Specifies the DB subnet group to associate with this DB instance. The default behavior varies depending on whether db_subnet_group_name is specified. Please refer to official AWS documentation to understand how db_subnet_group_name and publicly_accessible parameters affect DB instance behaviour. NOTE: This must match the db_subnet_group_name of the attached aws.rds.Cluster.
dbiResourceId String
Region-unique, immutable identifier for the DB instance.
endpoint String
DNS address for this instance. May not be writable
engine Changes to this property will trigger replacement.
Name of the database engine to be used for the RDS cluster instance. Valid Values: aurora-mysql, aurora-postgresql, mysql, postgres.(Note that mysql and postgres are Multi-AZ RDS clusters).
engineVersion String
Database engine version. Please note that to upgrade the engine_version of the instance, it must be done on the aws.rds.Cluster engine_version. Trying to upgrade in aws_cluster_instance will not update the engine_version.
engineVersionActual String
Database engine version
forceDestroy Boolean
Forces an instance to be destroyed when a part of a read replica cluster. Note: will promote the read replica to a standalone cluster before instance deletion.
identifier Changes to this property will trigger replacement. String
Identifier for the RDS instance, if omitted, Pulumi will assign a random, unique identifier.
identifierPrefix Changes to this property will trigger replacement. String
Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
instanceClass String | "db.t4g.micro" | "db.t4g.small" | "db.t4g.medium" | "db.t4g.large" | "db.t4g.xlarge" | "db.t4g.2xlarge" | "db.t3.micro" | "db.t3.small" | "db.t3.medium" | "db.t3.large" | "db.t3.xlarge" | "db.t3.2xlarge" | "db.t2.micro" | "db.t2.small" | "db.t2.medium" | "db.t2.large" | "db.t2.xlarge" | "db.t2.2xlarge" | "db.m1.small" | "db.m1.medium" | "db.m1.large" | "db.m1.xlarge" | "db.m2.xlarge" | "db.m2.2xlarge" | "db.m2.4xlarge" | "db.m3.medium" | "db.m3.large" | "db.m3.xlarge" | "db.m3.2xlarge" | "db.m4.large" | "db.m4.xlarge" | "db.m4.2xlarge" | "db.m4.4xlarge" | "db.m4.10xlarge" | "db.m4.10xlarge" | "db.m5.large" | "db.m5.xlarge" | "db.m5.2xlarge" | "db.m5.4xlarge" | "db.m5.12xlarge" | "db.m5.24xlarge" | "db.m6g.large" | "db.m6g.xlarge" | "db.m6g.2xlarge" | "db.m6g.4xlarge" | "db.m6g.8xlarge" | "db.m6g.12xlarge" | "db.m6g.16xlarge" | "db.r3.large" | "db.r3.xlarge" | "db.r3.2xlarge" | "db.r3.4xlarge" | "db.r3.8xlarge" | "db.r4.large" | "db.r4.xlarge" | "db.r4.2xlarge" | "db.r4.4xlarge" | "db.r4.8xlarge" | "db.r4.16xlarge" | "db.r5.large" | "db.r5.xlarge" | "db.r5.2xlarge" | "db.r5.4xlarge" | "db.r5.12xlarge" | "db.r5.24xlarge" | "db.r6g.large" | "db.r6g.xlarge" | "db.r6g.2xlarge" | "db.r6g.4xlarge" | "db.r6g.8xlarge" | "db.r6g.12xlarge" | "db.r6g.16xlarge" | "db.x1.16xlarge" | "db.x1.32xlarge" | "db.x1e.xlarge" | "db.x1e.2xlarge" | "db.x1e.4xlarge" | "db.x1e.8xlarge" | "db.x1e.32xlarge"
Instance class to use. For details on CPU and memory, see Scaling Aurora DB Instances. Aurora uses db.* instance classes/types. Please see AWS Documentation for currently available instance classes and complete details. For Aurora Serverless v2 use db.serverless.
kmsKeyId String
ARN for the KMS encryption key if one is set to the cluster.
monitoringInterval Number
Interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
monitoringRoleArn String
ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
networkType String
Network type of the DB instance.
performanceInsightsEnabled Boolean
Specifies whether Performance Insights is enabled or not. NOTE: When Performance Insights is configured at the cluster level through aws.rds.Cluster, this argument cannot be set to a value that conflicts with the cluster's configuration.
performanceInsightsKmsKeyId String
ARN for the KMS key to encrypt Performance Insights data. When specifying performance_insights_kms_key_id, performance_insights_enabled needs to be set to true.
performanceInsightsRetentionPeriod Number
Amount of time in days to retain Performance Insights data. Valid values are 7, 731 (2 years) or a multiple of 31. When specifying performance_insights_retention_period, performance_insights_enabled needs to be set to true. Defaults to '7'.
port Number
Database port
preferredBackupWindow String
Daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00". NOTE: If preferred_backup_window is set at the cluster level, this argument must be omitted.
preferredMaintenanceWindow String
Window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
promotionTier Number
Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoted to writer.
publiclyAccessible Boolean
Bool to control if instance is publicly accessible. Default false. See the documentation on Creating DB Instances for more details on controlling this property.
storageEncrypted Boolean
Specifies whether the DB cluster is encrypted.
tags Map<String>
Map of tags to assign to the instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String>
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

writer Boolean
Boolean indicating if this instance is writable. False indicates this instance is a read replica.

Supporting Types

InstanceType
, InstanceTypeArgs

T4G_Micro
db.t4g.micro
T4G_Small
db.t4g.small
T4G_Medium
db.t4g.medium
T4G_Large
db.t4g.large
T4G_XLarge
db.t4g.xlarge
T4G_2XLarge
db.t4g.2xlarge
T3_Micro
db.t3.micro
T3_Small
db.t3.small
T3_Medium
db.t3.medium
T3_Large
db.t3.large
T3_XLarge
db.t3.xlarge
T3_2XLarge
db.t3.2xlarge
T2_Micro
db.t2.micro
T2_Small
db.t2.small
T2_Medium
db.t2.medium
T2_Large
db.t2.large
T2_XLarge
db.t2.xlarge
T2_2XLarge
db.t2.2xlarge
M1_Small
db.m1.small
M1_Medium
db.m1.medium
M1_Large
db.m1.large
M1_XLarge
db.m1.xlarge
M2_XLarge
db.m2.xlarge
M2_2XLarge
db.m2.2xlarge
M2_4XLarge
db.m2.4xlarge
M3_Medium
db.m3.medium
M3_Large
db.m3.large
M3_XLarge
db.m3.xlarge
M3_2XLarge
db.m3.2xlarge
M4_Large
db.m4.large
M4_XLarge
db.m4.xlarge
M4_2XLarge
db.m4.2xlarge
M4_4XLarge
db.m4.4xlarge
M4_10XLarge
db.m4.10xlarge
M4_16XLarge
db.m4.10xlarge
M5_Large
db.m5.large
M5_XLarge
db.m5.xlarge
M5_2XLarge
db.m5.2xlarge
M5_4XLarge
db.m5.4xlarge
M5_12XLarge
db.m5.12xlarge
M5_24XLarge
db.m5.24xlarge
M6G_Large
db.m6g.large
M6G_XLarge
db.m6g.xlarge
M6G_2XLarge
db.m6g.2xlarge
M6G_4XLarge
db.m6g.4xlarge
M6G_8XLarge
db.m6g.8xlarge
M6G_12XLarge
db.m6g.12xlarge
M6G_16XLarge
db.m6g.16xlarge
R3_Large
db.r3.large
R3_XLarge
db.r3.xlarge
R3_2XLarge
db.r3.2xlarge
R3_4XLarge
db.r3.4xlarge
R3_8XLarge
db.r3.8xlarge
R4_Large
db.r4.large
R4_XLarge
db.r4.xlarge
R4_2XLarge
db.r4.2xlarge
R4_4XLarge
db.r4.4xlarge
R4_8XLarge
db.r4.8xlarge
R4_16XLarge
db.r4.16xlarge
R5_Large
db.r5.large
R5_XLarge
db.r5.xlarge
R5_2XLarge
db.r5.2xlarge
R5_4XLarge
db.r5.4xlarge
R5_12XLarge
db.r5.12xlarge
R5_24XLarge
db.r5.24xlarge
R6G_Large
db.r6g.large
R6G_XLarge
db.r6g.xlarge
R6G_2XLarge
db.r6g.2xlarge
R6G_4XLarge
db.r6g.4xlarge
R6G_8XLarge
db.r6g.8xlarge
R6G_12XLarge
db.r6g.12xlarge
R6G_16XLarge
db.r6g.16xlarge
X1_16XLarge
db.x1.16xlarge
X1_32XLarge
db.x1.32xlarge
X1E_XLarge
db.x1e.xlarge
X1E_2XLarge
db.x1e.2xlarge
X1E_4XLarge
db.x1e.4xlarge
X1E_8XLarge
db.x1e.8xlarge
X1E_32XLarge
db.x1e.32xlarge
InstanceType_T4G_Micro
db.t4g.micro
InstanceType_T4G_Small
db.t4g.small
InstanceType_T4G_Medium
db.t4g.medium
InstanceType_T4G_Large
db.t4g.large
InstanceType_T4G_XLarge
db.t4g.xlarge
InstanceType_T4G_2XLarge
db.t4g.2xlarge
InstanceType_T3_Micro
db.t3.micro
InstanceType_T3_Small
db.t3.small
InstanceType_T3_Medium
db.t3.medium
InstanceType_T3_Large
db.t3.large
InstanceType_T3_XLarge
db.t3.xlarge
InstanceType_T3_2XLarge
db.t3.2xlarge
InstanceType_T2_Micro
db.t2.micro
InstanceType_T2_Small
db.t2.small
InstanceType_T2_Medium
db.t2.medium
InstanceType_T2_Large
db.t2.large
InstanceType_T2_XLarge
db.t2.xlarge
InstanceType_T2_2XLarge
db.t2.2xlarge
InstanceType_M1_Small
db.m1.small
InstanceType_M1_Medium
db.m1.medium
InstanceType_M1_Large
db.m1.large
InstanceType_M1_XLarge
db.m1.xlarge
InstanceType_M2_XLarge
db.m2.xlarge
InstanceType_M2_2XLarge
db.m2.2xlarge
InstanceType_M2_4XLarge
db.m2.4xlarge
InstanceType_M3_Medium
db.m3.medium
InstanceType_M3_Large
db.m3.large
InstanceType_M3_XLarge
db.m3.xlarge
InstanceType_M3_2XLarge
db.m3.2xlarge
InstanceType_M4_Large
db.m4.large
InstanceType_M4_XLarge
db.m4.xlarge
InstanceType_M4_2XLarge
db.m4.2xlarge
InstanceType_M4_4XLarge
db.m4.4xlarge
InstanceType_M4_10XLarge
db.m4.10xlarge
InstanceType_M4_16XLarge
db.m4.10xlarge
InstanceType_M5_Large
db.m5.large
InstanceType_M5_XLarge
db.m5.xlarge
InstanceType_M5_2XLarge
db.m5.2xlarge
InstanceType_M5_4XLarge
db.m5.4xlarge
InstanceType_M5_12XLarge
db.m5.12xlarge
InstanceType_M5_24XLarge
db.m5.24xlarge
InstanceType_M6G_Large
db.m6g.large
InstanceType_M6G_XLarge
db.m6g.xlarge
InstanceType_M6G_2XLarge
db.m6g.2xlarge
InstanceType_M6G_4XLarge
db.m6g.4xlarge
InstanceType_M6G_8XLarge
db.m6g.8xlarge
InstanceType_M6G_12XLarge
db.m6g.12xlarge
InstanceType_M6G_16XLarge
db.m6g.16xlarge
InstanceType_R3_Large
db.r3.large
InstanceType_R3_XLarge
db.r3.xlarge
InstanceType_R3_2XLarge
db.r3.2xlarge
InstanceType_R3_4XLarge
db.r3.4xlarge
InstanceType_R3_8XLarge
db.r3.8xlarge
InstanceType_R4_Large
db.r4.large
InstanceType_R4_XLarge
db.r4.xlarge
InstanceType_R4_2XLarge
db.r4.2xlarge
InstanceType_R4_4XLarge
db.r4.4xlarge
InstanceType_R4_8XLarge
db.r4.8xlarge
InstanceType_R4_16XLarge
db.r4.16xlarge
InstanceType_R5_Large
db.r5.large
InstanceType_R5_XLarge
db.r5.xlarge
InstanceType_R5_2XLarge
db.r5.2xlarge
InstanceType_R5_4XLarge
db.r5.4xlarge
InstanceType_R5_12XLarge
db.r5.12xlarge
InstanceType_R5_24XLarge
db.r5.24xlarge
InstanceType_R6G_Large
db.r6g.large
InstanceType_R6G_XLarge
db.r6g.xlarge
InstanceType_R6G_2XLarge
db.r6g.2xlarge
InstanceType_R6G_4XLarge
db.r6g.4xlarge
InstanceType_R6G_8XLarge
db.r6g.8xlarge
InstanceType_R6G_12XLarge
db.r6g.12xlarge
InstanceType_R6G_16XLarge
db.r6g.16xlarge
InstanceType_X1_16XLarge
db.x1.16xlarge
InstanceType_X1_32XLarge
db.x1.32xlarge
InstanceType_X1E_XLarge
db.x1e.xlarge
InstanceType_X1E_2XLarge
db.x1e.2xlarge
InstanceType_X1E_4XLarge
db.x1e.4xlarge
InstanceType_X1E_8XLarge
db.x1e.8xlarge
InstanceType_X1E_32XLarge
db.x1e.32xlarge
T4G_Micro
db.t4g.micro
T4G_Small
db.t4g.small
T4G_Medium
db.t4g.medium
T4G_Large
db.t4g.large
T4G_XLarge
db.t4g.xlarge
T4G_2XLarge
db.t4g.2xlarge
T3_Micro
db.t3.micro
T3_Small
db.t3.small
T3_Medium
db.t3.medium
T3_Large
db.t3.large
T3_XLarge
db.t3.xlarge
T3_2XLarge
db.t3.2xlarge
T2_Micro
db.t2.micro
T2_Small
db.t2.small
T2_Medium
db.t2.medium
T2_Large
db.t2.large
T2_XLarge
db.t2.xlarge
T2_2XLarge
db.t2.2xlarge
M1_Small
db.m1.small
M1_Medium
db.m1.medium
M1_Large
db.m1.large
M1_XLarge
db.m1.xlarge
M2_XLarge
db.m2.xlarge
M2_2XLarge
db.m2.2xlarge
M2_4XLarge
db.m2.4xlarge
M3_Medium
db.m3.medium
M3_Large
db.m3.large
M3_XLarge
db.m3.xlarge
M3_2XLarge
db.m3.2xlarge
M4_Large
db.m4.large
M4_XLarge
db.m4.xlarge
M4_2XLarge
db.m4.2xlarge
M4_4XLarge
db.m4.4xlarge
M4_10XLarge
db.m4.10xlarge
M4_16XLarge
db.m4.10xlarge
M5_Large
db.m5.large
M5_XLarge
db.m5.xlarge
M5_2XLarge
db.m5.2xlarge
M5_4XLarge
db.m5.4xlarge
M5_12XLarge
db.m5.12xlarge
M5_24XLarge
db.m5.24xlarge
M6G_Large
db.m6g.large
M6G_XLarge
db.m6g.xlarge
M6G_2XLarge
db.m6g.2xlarge
M6G_4XLarge
db.m6g.4xlarge
M6G_8XLarge
db.m6g.8xlarge
M6G_12XLarge
db.m6g.12xlarge
M6G_16XLarge
db.m6g.16xlarge
R3_Large
db.r3.large
R3_XLarge
db.r3.xlarge
R3_2XLarge
db.r3.2xlarge
R3_4XLarge
db.r3.4xlarge
R3_8XLarge
db.r3.8xlarge
R4_Large
db.r4.large
R4_XLarge
db.r4.xlarge
R4_2XLarge
db.r4.2xlarge
R4_4XLarge
db.r4.4xlarge
R4_8XLarge
db.r4.8xlarge
R4_16XLarge
db.r4.16xlarge
R5_Large
db.r5.large
R5_XLarge
db.r5.xlarge
R5_2XLarge
db.r5.2xlarge
R5_4XLarge
db.r5.4xlarge
R5_12XLarge
db.r5.12xlarge
R5_24XLarge
db.r5.24xlarge
R6G_Large
db.r6g.large
R6G_XLarge
db.r6g.xlarge
R6G_2XLarge
db.r6g.2xlarge
R6G_4XLarge
db.r6g.4xlarge
R6G_8XLarge
db.r6g.8xlarge
R6G_12XLarge
db.r6g.12xlarge
R6G_16XLarge
db.r6g.16xlarge
X1_16XLarge
db.x1.16xlarge
X1_32XLarge
db.x1.32xlarge
X1E_XLarge
db.x1e.xlarge
X1E_2XLarge
db.x1e.2xlarge
X1E_4XLarge
db.x1e.4xlarge
X1E_8XLarge
db.x1e.8xlarge
X1E_32XLarge
db.x1e.32xlarge
T4G_Micro
db.t4g.micro
T4G_Small
db.t4g.small
T4G_Medium
db.t4g.medium
T4G_Large
db.t4g.large
T4G_XLarge
db.t4g.xlarge
T4G_2XLarge
db.t4g.2xlarge
T3_Micro
db.t3.micro
T3_Small
db.t3.small
T3_Medium
db.t3.medium
T3_Large
db.t3.large
T3_XLarge
db.t3.xlarge
T3_2XLarge
db.t3.2xlarge
T2_Micro
db.t2.micro
T2_Small
db.t2.small
T2_Medium
db.t2.medium
T2_Large
db.t2.large
T2_XLarge
db.t2.xlarge
T2_2XLarge
db.t2.2xlarge
M1_Small
db.m1.small
M1_Medium
db.m1.medium
M1_Large
db.m1.large
M1_XLarge
db.m1.xlarge
M2_XLarge
db.m2.xlarge
M2_2XLarge
db.m2.2xlarge
M2_4XLarge
db.m2.4xlarge
M3_Medium
db.m3.medium
M3_Large
db.m3.large
M3_XLarge
db.m3.xlarge
M3_2XLarge
db.m3.2xlarge
M4_Large
db.m4.large
M4_XLarge
db.m4.xlarge
M4_2XLarge
db.m4.2xlarge
M4_4XLarge
db.m4.4xlarge
M4_10XLarge
db.m4.10xlarge
M4_16XLarge
db.m4.10xlarge
M5_Large
db.m5.large
M5_XLarge
db.m5.xlarge
M5_2XLarge
db.m5.2xlarge
M5_4XLarge
db.m5.4xlarge
M5_12XLarge
db.m5.12xlarge
M5_24XLarge
db.m5.24xlarge
M6G_Large
db.m6g.large
M6G_XLarge
db.m6g.xlarge
M6G_2XLarge
db.m6g.2xlarge
M6G_4XLarge
db.m6g.4xlarge
M6G_8XLarge
db.m6g.8xlarge
M6G_12XLarge
db.m6g.12xlarge
M6G_16XLarge
db.m6g.16xlarge
R3_Large
db.r3.large
R3_XLarge
db.r3.xlarge
R3_2XLarge
db.r3.2xlarge
R3_4XLarge
db.r3.4xlarge
R3_8XLarge
db.r3.8xlarge
R4_Large
db.r4.large
R4_XLarge
db.r4.xlarge
R4_2XLarge
db.r4.2xlarge
R4_4XLarge
db.r4.4xlarge
R4_8XLarge
db.r4.8xlarge
R4_16XLarge
db.r4.16xlarge
R5_Large
db.r5.large
R5_XLarge
db.r5.xlarge
R5_2XLarge
db.r5.2xlarge
R5_4XLarge
db.r5.4xlarge
R5_12XLarge
db.r5.12xlarge
R5_24XLarge
db.r5.24xlarge
R6G_Large
db.r6g.large
R6G_XLarge
db.r6g.xlarge
R6G_2XLarge
db.r6g.2xlarge
R6G_4XLarge
db.r6g.4xlarge
R6G_8XLarge
db.r6g.8xlarge
R6G_12XLarge
db.r6g.12xlarge
R6G_16XLarge
db.r6g.16xlarge
X1_16XLarge
db.x1.16xlarge
X1_32XLarge
db.x1.32xlarge
X1E_XLarge
db.x1e.xlarge
X1E_2XLarge
db.x1e.2xlarge
X1E_4XLarge
db.x1e.4xlarge
X1E_8XLarge
db.x1e.8xlarge
X1E_32XLarge
db.x1e.32xlarge
T4_G_MICRO
db.t4g.micro
T4_G_SMALL
db.t4g.small
T4_G_MEDIUM
db.t4g.medium
T4_G_LARGE
db.t4g.large
T4_G_X_LARGE
db.t4g.xlarge
T4_G_2_X_LARGE
db.t4g.2xlarge
T3_MICRO
db.t3.micro
T3_SMALL
db.t3.small
T3_MEDIUM
db.t3.medium
T3_LARGE
db.t3.large
T3_X_LARGE
db.t3.xlarge
T3_2_X_LARGE
db.t3.2xlarge
T2_MICRO
db.t2.micro
T2_SMALL
db.t2.small
T2_MEDIUM
db.t2.medium
T2_LARGE
db.t2.large
T2_X_LARGE
db.t2.xlarge
T2_2_X_LARGE
db.t2.2xlarge
M1_SMALL
db.m1.small
M1_MEDIUM
db.m1.medium
M1_LARGE
db.m1.large
M1_X_LARGE
db.m1.xlarge
M2_X_LARGE
db.m2.xlarge
M2_2_X_LARGE
db.m2.2xlarge
M2_4_X_LARGE
db.m2.4xlarge
M3_MEDIUM
db.m3.medium
M3_LARGE
db.m3.large
M3_X_LARGE
db.m3.xlarge
M3_2_X_LARGE
db.m3.2xlarge
M4_LARGE
db.m4.large
M4_X_LARGE
db.m4.xlarge
M4_2_X_LARGE
db.m4.2xlarge
M4_4_X_LARGE
db.m4.4xlarge
M4_10_X_LARGE
db.m4.10xlarge
M4_16_X_LARGE
db.m4.10xlarge
M5_LARGE
db.m5.large
M5_X_LARGE
db.m5.xlarge
M5_2_X_LARGE
db.m5.2xlarge
M5_4_X_LARGE
db.m5.4xlarge
M5_12_X_LARGE
db.m5.12xlarge
M5_24_X_LARGE
db.m5.24xlarge
M6_G_LARGE
db.m6g.large
M6_G_X_LARGE
db.m6g.xlarge
M6_G_2_X_LARGE
db.m6g.2xlarge
M6_G_4_X_LARGE
db.m6g.4xlarge
M6_G_8_X_LARGE
db.m6g.8xlarge
M6_G_12_X_LARGE
db.m6g.12xlarge
M6_G_16_X_LARGE
db.m6g.16xlarge
R3_LARGE
db.r3.large
R3_X_LARGE
db.r3.xlarge
R3_2_X_LARGE
db.r3.2xlarge
R3_4_X_LARGE
db.r3.4xlarge
R3_8_X_LARGE
db.r3.8xlarge
R4_LARGE
db.r4.large
R4_X_LARGE
db.r4.xlarge
R4_2_X_LARGE
db.r4.2xlarge
R4_4_X_LARGE
db.r4.4xlarge
R4_8_X_LARGE
db.r4.8xlarge
R4_16_X_LARGE
db.r4.16xlarge
R5_LARGE
db.r5.large
R5_X_LARGE
db.r5.xlarge
R5_2_X_LARGE
db.r5.2xlarge
R5_4_X_LARGE
db.r5.4xlarge
R5_12_X_LARGE
db.r5.12xlarge
R5_24_X_LARGE
db.r5.24xlarge
R6_G_LARGE
db.r6g.large
R6_G_X_LARGE
db.r6g.xlarge
R6_G_2_X_LARGE
db.r6g.2xlarge
R6_G_4_X_LARGE
db.r6g.4xlarge
R6_G_8_X_LARGE
db.r6g.8xlarge
R6_G_12_X_LARGE
db.r6g.12xlarge
R6_G_16_X_LARGE
db.r6g.16xlarge
X1_16_X_LARGE
db.x1.16xlarge
X1_32_X_LARGE
db.x1.32xlarge
X1_E_X_LARGE
db.x1e.xlarge
X1_E_2_X_LARGE
db.x1e.2xlarge
X1_E_4_X_LARGE
db.x1e.4xlarge
X1_E_8_X_LARGE
db.x1e.8xlarge
X1_E_32_X_LARGE
db.x1e.32xlarge
"db.t4g.micro"
db.t4g.micro
"db.t4g.small"
db.t4g.small
"db.t4g.medium"
db.t4g.medium
"db.t4g.large"
db.t4g.large
"db.t4g.xlarge"
db.t4g.xlarge
"db.t4g.2xlarge"
db.t4g.2xlarge
"db.t3.micro"
db.t3.micro
"db.t3.small"
db.t3.small
"db.t3.medium"
db.t3.medium
"db.t3.large"
db.t3.large
"db.t3.xlarge"
db.t3.xlarge
"db.t3.2xlarge"
db.t3.2xlarge
"db.t2.micro"
db.t2.micro
"db.t2.small"
db.t2.small
"db.t2.medium"
db.t2.medium
"db.t2.large"
db.t2.large
"db.t2.xlarge"
db.t2.xlarge
"db.t2.2xlarge"
db.t2.2xlarge
"db.m1.small"
db.m1.small
"db.m1.medium"
db.m1.medium
"db.m1.large"
db.m1.large
"db.m1.xlarge"
db.m1.xlarge
"db.m2.xlarge"
db.m2.xlarge
"db.m2.2xlarge"
db.m2.2xlarge
"db.m2.4xlarge"
db.m2.4xlarge
"db.m3.medium"
db.m3.medium
"db.m3.large"
db.m3.large
"db.m3.xlarge"
db.m3.xlarge
"db.m3.2xlarge"
db.m3.2xlarge
"db.m4.large"
db.m4.large
"db.m4.xlarge"
db.m4.xlarge
"db.m4.2xlarge"
db.m4.2xlarge
"db.m4.4xlarge"
db.m4.4xlarge
"db.m4.10xlarge"
db.m4.10xlarge
"db.m4.10xlarge"
db.m4.10xlarge
"db.m5.large"
db.m5.large
"db.m5.xlarge"
db.m5.xlarge
"db.m5.2xlarge"
db.m5.2xlarge
"db.m5.4xlarge"
db.m5.4xlarge
"db.m5.12xlarge"
db.m5.12xlarge
"db.m5.24xlarge"
db.m5.24xlarge
"db.m6g.large"
db.m6g.large
"db.m6g.xlarge"
db.m6g.xlarge
"db.m6g.2xlarge"
db.m6g.2xlarge
"db.m6g.4xlarge"
db.m6g.4xlarge
"db.m6g.8xlarge"
db.m6g.8xlarge
"db.m6g.12xlarge"
db.m6g.12xlarge
"db.m6g.16xlarge"
db.m6g.16xlarge
"db.r3.large"
db.r3.large
"db.r3.xlarge"
db.r3.xlarge
"db.r3.2xlarge"
db.r3.2xlarge
"db.r3.4xlarge"
db.r3.4xlarge
"db.r3.8xlarge"
db.r3.8xlarge
"db.r4.large"
db.r4.large
"db.r4.xlarge"
db.r4.xlarge
"db.r4.2xlarge"
db.r4.2xlarge
"db.r4.4xlarge"
db.r4.4xlarge
"db.r4.8xlarge"
db.r4.8xlarge
"db.r4.16xlarge"
db.r4.16xlarge
"db.r5.large"
db.r5.large
"db.r5.xlarge"
db.r5.xlarge
"db.r5.2xlarge"
db.r5.2xlarge
"db.r5.4xlarge"
db.r5.4xlarge
"db.r5.12xlarge"
db.r5.12xlarge
"db.r5.24xlarge"
db.r5.24xlarge
"db.r6g.large"
db.r6g.large
"db.r6g.xlarge"
db.r6g.xlarge
"db.r6g.2xlarge"
db.r6g.2xlarge
"db.r6g.4xlarge"
db.r6g.4xlarge
"db.r6g.8xlarge"
db.r6g.8xlarge
"db.r6g.12xlarge"
db.r6g.12xlarge
"db.r6g.16xlarge"
db.r6g.16xlarge
"db.x1.16xlarge"
db.x1.16xlarge
"db.x1.32xlarge"
db.x1.32xlarge
"db.x1e.xlarge"
db.x1e.xlarge
"db.x1e.2xlarge"
db.x1e.2xlarge
"db.x1e.4xlarge"
db.x1e.4xlarge
"db.x1e.8xlarge"
db.x1e.8xlarge
"db.x1e.32xlarge"
db.x1e.32xlarge

Import

Using pulumi import, import RDS Cluster Instances using the identifier. For example:

$ pulumi import aws:rds/clusterInstance:ClusterInstance prod_instance_1 aurora-cluster-instance-1
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.75.0 published on Wednesday, Apr 2, 2025 by Pulumi
pulumi/pulumi-aws