ClusterInstance

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

Example Usage

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var @default = new Aws.Rds.Cluster("default", new Aws.Rds.ClusterArgs
        {
            AvailabilityZones = 
            {
                "us-west-2a",
                "us-west-2b",
                "us-west-2c",
            },
            ClusterIdentifier = "aurora-cluster-demo",
            DatabaseName = "mydb",
            MasterPassword = "barbut8chars",
            MasterUsername = "foo",
        });
        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($"clusterInstances-{range.Value}", new Aws.Rds.ClusterInstanceArgs
            {
                ClusterIdentifier = @default.Id,
                Identifier = $"aurora-cluster-demo-{range.Value}",
                InstanceClass = "db.r4.large",
            }));
        }
    }

}

package main

import (
    "fmt"

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := rds.NewCluster(ctx, "_default", &rds.ClusterArgs{
            AvailabilityZones: pulumi.StringArray{
                pulumi.String("us-west-2a"),
                pulumi.String("us-west-2b"),
                pulumi.String("us-west-2c"),
            },
            ClusterIdentifier: pulumi.String("aurora-cluster-demo"),
            DatabaseName:      pulumi.String("mydb"),
            MasterPassword:    pulumi.String("barbut8chars"),
            MasterUsername:    pulumi.String("foo"),
        })
        if err != nil {
            return err
        }
        var clusterInstances []*rds.ClusterInstance
        for key0, val0 := range 2 {
            __res, err := rds.NewClusterInstance(ctx, fmt.Sprintf("clusterInstances-%v", key0), &rds.ClusterInstanceArgs{
                ClusterIdentifier: _default.ID(),
                Identifier:        pulumi.String(fmt.Sprintf("%v%v", "aurora-cluster-demo-", val0)),
                InstanceClass:     pulumi.String("db.r4.large"),
            })
            if err != nil {
                return err
            }
            clusterInstances = append(clusterInstances, __res)
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

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

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

const defaultCluster = new aws.rds.Cluster("default", {
    availabilityZones: [
        "us-west-2a",
        "us-west-2b",
        "us-west-2c",
    ],
    clusterIdentifier: "aurora-cluster-demo",
    databaseName: "mydb",
    masterPassword: "barbut8chars",
    masterUsername: "foo",
});
const clusterInstances: aws.rds.ClusterInstance[] = [];
for (let i = 0; i < 2; i++) {
    clusterInstances.push(new aws.rds.ClusterInstance(`cluster_instances-${i}`, {
        clusterIdentifier: defaultCluster.id,
        identifier: `aurora-cluster-demo-${i}`,
        instanceClass: "db.r4.large",
    }));
}

Create a ClusterInstance Resource

new ClusterInstance(name: string, args: ClusterInstanceArgs, opts?: CustomResourceOptions);

def ClusterInstance(resource_name, opts=None, apply_immediately=None, auto_minor_version_upgrade=None, availability_zone=None, ca_cert_identifier=None, cluster_identifier=None, copy_tags_to_snapshot=None, db_parameter_group_name=None, db_subnet_group_name=None, engine=None, engine_version=None, identifier=None, identifier_prefix=None, instance_class=None, monitoring_interval=None, monitoring_role_arn=None, performance_insights_enabled=None, performance_insights_kms_key_id=None, preferred_backup_window=None, preferred_maintenance_window=None, promotion_tier=None, publicly_accessible=None, tags=None, __props__=None);

func NewClusterInstance(ctx *Context, name string, args ClusterInstanceArgs, opts ...ResourceOption) (*ClusterInstance, error)

public ClusterInstance(string name, ClusterInstanceArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args ClusterInstanceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ClusterInstanceArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ClusterInstanceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.