AWS v6.54.0, Sep 27 24

AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi

aws.rds.Cluster

Explore with Pulumi AI

AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi

Manages a RDS Aurora Cluster or a RDS Multi-AZ DB Cluster. To manage cluster instances that inherit configuration from the cluster (when not running the cluster in serverless engine mode), see the aws.rds.ClusterInstance resource. To manage non-Aurora DB instances (e.g., MySQL, PostgreSQL, SQL Server, etc.), see the aws.rds.Instance resource.

For information on the difference between the available Aurora MySQL engines see Comparison between Aurora MySQL 1 and Aurora MySQL 2 in the Amazon RDS User Guide.

Changes to an RDS Cluster can occur when you manually change a parameter, such as port, and are reflected in the next maintenance window. Because of this, this provider may report a difference in its planning phase because a modification has not yet taken place. You can use the apply_immediately flag to instruct the service to apply the change immediately (see documentation below).

Note: Multi-AZ DB clusters are supported only for the MySQL and PostgreSQL DB engines.

Note: ca_certificate_identifier is only supported for Multi-AZ DB clusters.

Note: using apply_immediately can result in a brief downtime as the server reboots. See the AWS Docs on RDS Maintenance for more information.

Note: All arguments including the username and password will be stored in the raw state as plain-text. NOTE on RDS Clusters and RDS Cluster Role Associations: Pulumi provides both a standalone RDS Cluster Role Association - (an association between an RDS Cluster and a single IAM Role) and an RDS Cluster resource with iam_roles attributes. Use one resource or the other to associate IAM Roles and RDS Clusters. Not doing so will cause a conflict of associations and will result in the association being overwritten.

Example Usage

Aurora MySQL 2.x (MySQL 5.7)

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

const _default = new aws.rds.Cluster("default", {
    clusterIdentifier: "aurora-cluster-demo",
    engine: aws.rds.EngineType.AuroraMysql,
    engineVersion: "5.7.mysql_aurora.2.03.2",
    availabilityZones: [
        "us-west-2a",
        "us-west-2b",
        "us-west-2c",
    ],
    databaseName: "mydb",
    masterUsername: "foo",
    masterPassword: "must_be_eight_characters",
    backupRetentionPeriod: 5,
    preferredBackupWindow: "07:00-09:00",
});

import pulumi
import pulumi_aws as aws

default = aws.rds.Cluster("default",
    cluster_identifier="aurora-cluster-demo",
    engine=aws.rds.EngineType.AURORA_MYSQL,
    engine_version="5.7.mysql_aurora.2.03.2",
    availability_zones=[
        "us-west-2a",
        "us-west-2b",
        "us-west-2c",
    ],
    database_name="mydb",
    master_username="foo",
    master_password="must_be_eight_characters",
    backup_retention_period=5,
    preferred_backup_window="07:00-09:00")

package main

import (
	"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 {
		_, err := rds.NewCluster(ctx, "default", &rds.ClusterArgs{
			ClusterIdentifier: pulumi.String("aurora-cluster-demo"),
			Engine:            pulumi.String(rds.EngineTypeAuroraMysql),
			EngineVersion:     pulumi.String("5.7.mysql_aurora.2.03.2"),
			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("must_be_eight_characters"),
			BackupRetentionPeriod: pulumi.Int(5),
			PreferredBackupWindow: pulumi.String("07:00-09:00"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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",
        Engine = Aws.Rds.EngineType.AuroraMysql,
        EngineVersion = "5.7.mysql_aurora.2.03.2",
        AvailabilityZones = new[]
        {
            "us-west-2a",
            "us-west-2b",
            "us-west-2c",
        },
        DatabaseName = "mydb",
        MasterUsername = "foo",
        MasterPassword = "must_be_eight_characters",
        BackupRetentionPeriod = 5,
        PreferredBackupWindow = "07:00-09:00",
    });

});

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 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")
            .engine("aurora-mysql")
            .engineVersion("5.7.mysql_aurora.2.03.2")
            .availabilityZones(            
                "us-west-2a",
                "us-west-2b",
                "us-west-2c")
            .databaseName("mydb")
            .masterUsername("foo")
            .masterPassword("must_be_eight_characters")
            .backupRetentionPeriod(5)
            .preferredBackupWindow("07:00-09:00")
            .build());

    }
}

resources:
  default:
    type: aws:rds:Cluster
    properties:
      clusterIdentifier: aurora-cluster-demo
      engine: aurora-mysql
      engineVersion: 5.7.mysql_aurora.2.03.2
      availabilityZones:
        - us-west-2a
        - us-west-2b
        - us-west-2c
      databaseName: mydb
      masterUsername: foo
      masterPassword: must_be_eight_characters
      backupRetentionPeriod: 5
      preferredBackupWindow: 07:00-09:00

Aurora MySQL 1.x (MySQL 5.6)

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: "must_be_eight_characters",
    backupRetentionPeriod: 5,
    preferredBackupWindow: "07:00-09:00",
});

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="must_be_eight_characters",
    backup_retention_period=5,
    preferred_backup_window="07:00-09:00")

package main

import (
	"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 {
		_, 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("must_be_eight_characters"),
			BackupRetentionPeriod: pulumi.Int(5),
			PreferredBackupWindow: pulumi.String("07:00-09:00"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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 = "must_be_eight_characters",
        BackupRetentionPeriod = 5,
        PreferredBackupWindow = "07:00-09:00",
    });

});

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 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("must_be_eight_characters")
            .backupRetentionPeriod(5)
            .preferredBackupWindow("07:00-09:00")
            .build());

    }
}

resources:
  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: must_be_eight_characters
      backupRetentionPeriod: 5
      preferredBackupWindow: 07:00-09:00

Aurora with PostgreSQL engine

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

const postgresql = new aws.rds.Cluster("postgresql", {
    clusterIdentifier: "aurora-cluster-demo",
    engine: aws.rds.EngineType.AuroraPostgresql,
    availabilityZones: [
        "us-west-2a",
        "us-west-2b",
        "us-west-2c",
    ],
    databaseName: "mydb",
    masterUsername: "foo",
    masterPassword: "must_be_eight_characters",
    backupRetentionPeriod: 5,
    preferredBackupWindow: "07:00-09:00",
});

import pulumi
import pulumi_aws as aws

postgresql = aws.rds.Cluster("postgresql",
    cluster_identifier="aurora-cluster-demo",
    engine=aws.rds.EngineType.AURORA_POSTGRESQL,
    availability_zones=[
        "us-west-2a",
        "us-west-2b",
        "us-west-2c",
    ],
    database_name="mydb",
    master_username="foo",
    master_password="must_be_eight_characters",
    backup_retention_period=5,
    preferred_backup_window="07:00-09:00")

package main

import (
	"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 {
		_, err := rds.NewCluster(ctx, "postgresql", &rds.ClusterArgs{
			ClusterIdentifier: pulumi.String("aurora-cluster-demo"),
			Engine:            pulumi.String(rds.EngineTypeAuroraPostgresql),
			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("must_be_eight_characters"),
			BackupRetentionPeriod: pulumi.Int(5),
			PreferredBackupWindow: pulumi.String("07:00-09:00"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var postgresql = new Aws.Rds.Cluster("postgresql", new()
    {
        ClusterIdentifier = "aurora-cluster-demo",
        Engine = Aws.Rds.EngineType.AuroraPostgresql,
        AvailabilityZones = new[]
        {
            "us-west-2a",
            "us-west-2b",
            "us-west-2c",
        },
        DatabaseName = "mydb",
        MasterUsername = "foo",
        MasterPassword = "must_be_eight_characters",
        BackupRetentionPeriod = 5,
        PreferredBackupWindow = "07:00-09:00",
    });

});

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 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 postgresql = new Cluster("postgresql", ClusterArgs.builder()
            .clusterIdentifier("aurora-cluster-demo")
            .engine("aurora-postgresql")
            .availabilityZones(            
                "us-west-2a",
                "us-west-2b",
                "us-west-2c")
            .databaseName("mydb")
            .masterUsername("foo")
            .masterPassword("must_be_eight_characters")
            .backupRetentionPeriod(5)
            .preferredBackupWindow("07:00-09:00")
            .build());

    }
}

resources:
  postgresql:
    type: aws:rds:Cluster
    properties:
      clusterIdentifier: aurora-cluster-demo
      engine: aurora-postgresql
      availabilityZones:
        - us-west-2a
        - us-west-2b
        - us-west-2c
      databaseName: mydb
      masterUsername: foo
      masterPassword: must_be_eight_characters
      backupRetentionPeriod: 5
      preferredBackupWindow: 07:00-09:00

RDS Multi-AZ Cluster

More information about RDS Multi-AZ Clusters can be found in the RDS User Guide.

To create a Multi-AZ RDS cluster, you must additionally specify the engine, storage_type, allocated_storage, iops and db_cluster_instance_class attributes.

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

const example = new aws.rds.Cluster("example", {
    clusterIdentifier: "example",
    availabilityZones: [
        "us-west-2a",
        "us-west-2b",
        "us-west-2c",
    ],
    engine: "mysql",
    dbClusterInstanceClass: "db.r6gd.xlarge",
    storageType: "io1",
    allocatedStorage: 100,
    iops: 1000,
    masterUsername: "test",
    masterPassword: "mustbeeightcharaters",
});

import pulumi
import pulumi_aws as aws

example = aws.rds.Cluster("example",
    cluster_identifier="example",
    availability_zones=[
        "us-west-2a",
        "us-west-2b",
        "us-west-2c",
    ],
    engine="mysql",
    db_cluster_instance_class="db.r6gd.xlarge",
    storage_type="io1",
    allocated_storage=100,
    iops=1000,
    master_username="test",
    master_password="mustbeeightcharaters")

package main

import (
	"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 {
		_, err := rds.NewCluster(ctx, "example", &rds.ClusterArgs{
			ClusterIdentifier: pulumi.String("example"),
			AvailabilityZones: pulumi.StringArray{
				pulumi.String("us-west-2a"),
				pulumi.String("us-west-2b"),
				pulumi.String("us-west-2c"),
			},
			Engine:                 pulumi.String("mysql"),
			DbClusterInstanceClass: pulumi.String("db.r6gd.xlarge"),
			StorageType:            pulumi.String("io1"),
			AllocatedStorage:       pulumi.Int(100),
			Iops:                   pulumi.Int(1000),
			MasterUsername:         pulumi.String("test"),
			MasterPassword:         pulumi.String("mustbeeightcharaters"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Rds.Cluster("example", new()
    {
        ClusterIdentifier = "example",
        AvailabilityZones = new[]
        {
            "us-west-2a",
            "us-west-2b",
            "us-west-2c",
        },
        Engine = "mysql",
        DbClusterInstanceClass = "db.r6gd.xlarge",
        StorageType = "io1",
        AllocatedStorage = 100,
        Iops = 1000,
        MasterUsername = "test",
        MasterPassword = "mustbeeightcharaters",
    });

});

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 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 example = new Cluster("example", ClusterArgs.builder()
            .clusterIdentifier("example")
            .availabilityZones(            
                "us-west-2a",
                "us-west-2b",
                "us-west-2c")
            .engine("mysql")
            .dbClusterInstanceClass("db.r6gd.xlarge")
            .storageType("io1")
            .allocatedStorage(100)
            .iops(1000)
            .masterUsername("test")
            .masterPassword("mustbeeightcharaters")
            .build());

    }
}

resources:
  example:
    type: aws:rds:Cluster
    properties:
      clusterIdentifier: example
      availabilityZones:
        - us-west-2a
        - us-west-2b
        - us-west-2c
      engine: mysql
      dbClusterInstanceClass: db.r6gd.xlarge
      storageType: io1
      allocatedStorage: 100
      iops: 1000
      masterUsername: test
      masterPassword: mustbeeightcharaters

RDS Serverless v2 Cluster

More information about RDS Serverless v2 Clusters can be found in the RDS User Guide.

Note: Unlike Serverless v1, in Serverless v2 the storage_encrypted value is set to false by default. This is because Serverless v1 uses the serverless engine_mode, but Serverless v2 uses the provisioned engine_mode.

To create a Serverless v2 RDS cluster, you must additionally specify the engine_mode and serverlessv2_scaling_configuration attributes. An aws.rds.ClusterInstance resource must also be added to the cluster with the instance_class attribute specified.

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

const example = new aws.rds.Cluster("example", {
    clusterIdentifier: "example",
    engine: aws.rds.EngineType.AuroraPostgresql,
    engineMode: aws.rds.EngineMode.Provisioned,
    engineVersion: "13.6",
    databaseName: "test",
    masterUsername: "test",
    masterPassword: "must_be_eight_characters",
    storageEncrypted: true,
    serverlessv2ScalingConfiguration: {
        maxCapacity: 1,
        minCapacity: 0.5,
    },
});
const exampleClusterInstance = new aws.rds.ClusterInstance("example", {
    clusterIdentifier: example.id,
    instanceClass: "db.serverless",
    engine: example.engine,
    engineVersion: example.engineVersion,
});

import pulumi
import pulumi_aws as aws

example = aws.rds.Cluster("example",
    cluster_identifier="example",
    engine=aws.rds.EngineType.AURORA_POSTGRESQL,
    engine_mode=aws.rds.EngineMode.PROVISIONED,
    engine_version="13.6",
    database_name="test",
    master_username="test",
    master_password="must_be_eight_characters",
    storage_encrypted=True,
    serverlessv2_scaling_configuration={
        "max_capacity": 1,
        "min_capacity": 0.5,
    })
example_cluster_instance = aws.rds.ClusterInstance("example",
    cluster_identifier=example.id,
    instance_class="db.serverless",
    engine=example.engine,
    engine_version=example.engine_version)

package main

import (
	"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 {
		example, err := rds.NewCluster(ctx, "example", &rds.ClusterArgs{
			ClusterIdentifier: pulumi.String("example"),
			Engine:            pulumi.String(rds.EngineTypeAuroraPostgresql),
			EngineMode:        pulumi.String(rds.EngineModeProvisioned),
			EngineVersion:     pulumi.String("13.6"),
			DatabaseName:      pulumi.String("test"),
			MasterUsername:    pulumi.String("test"),
			MasterPassword:    pulumi.String("must_be_eight_characters"),
			StorageEncrypted:  pulumi.Bool(true),
			Serverlessv2ScalingConfiguration: &rds.ClusterServerlessv2ScalingConfigurationArgs{
				MaxCapacity: pulumi.Float64(1),
				MinCapacity: pulumi.Float64(0.5),
			},
		})
		if err != nil {
			return err
		}
		_, err = rds.NewClusterInstance(ctx, "example", &rds.ClusterInstanceArgs{
			ClusterIdentifier: example.ID(),
			InstanceClass:     pulumi.String("db.serverless"),
			Engine:            example.Engine,
			EngineVersion:     example.EngineVersion,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Rds.Cluster("example", new()
    {
        ClusterIdentifier = "example",
        Engine = Aws.Rds.EngineType.AuroraPostgresql,
        EngineMode = Aws.Rds.EngineMode.Provisioned,
        EngineVersion = "13.6",
        DatabaseName = "test",
        MasterUsername = "test",
        MasterPassword = "must_be_eight_characters",
        StorageEncrypted = true,
        Serverlessv2ScalingConfiguration = new Aws.Rds.Inputs.ClusterServerlessv2ScalingConfigurationArgs
        {
            MaxCapacity = 1,
            MinCapacity = 0.5,
        },
    });

    var exampleClusterInstance = new Aws.Rds.ClusterInstance("example", new()
    {
        ClusterIdentifier = example.Id,
        InstanceClass = "db.serverless",
        Engine = example.Engine,
        EngineVersion = example.EngineVersion,
    });

});

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.inputs.ClusterServerlessv2ScalingConfigurationArgs;
import com.pulumi.aws.rds.ClusterInstance;
import com.pulumi.aws.rds.ClusterInstanceArgs;
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 example = new Cluster("example", ClusterArgs.builder()
            .clusterIdentifier("example")
            .engine("aurora-postgresql")
            .engineMode("provisioned")
            .engineVersion("13.6")
            .databaseName("test")
            .masterUsername("test")
            .masterPassword("must_be_eight_characters")
            .storageEncrypted(true)
            .serverlessv2ScalingConfiguration(ClusterServerlessv2ScalingConfigurationArgs.builder()
                .maxCapacity(1)
                .minCapacity(0.5)
                .build())
            .build());

        var exampleClusterInstance = new ClusterInstance("exampleClusterInstance", ClusterInstanceArgs.builder()
            .clusterIdentifier(example.id())
            .instanceClass("db.serverless")
            .engine(example.engine())
            .engineVersion(example.engineVersion())
            .build());

    }
}

resources:
  example:
    type: aws:rds:Cluster
    properties:
      clusterIdentifier: example
      engine: aurora-postgresql
      engineMode: provisioned
      engineVersion: '13.6'
      databaseName: test
      masterUsername: test
      masterPassword: must_be_eight_characters
      storageEncrypted: true
      serverlessv2ScalingConfiguration:
        maxCapacity: 1
        minCapacity: 0.5
  exampleClusterInstance:
    type: aws:rds:ClusterInstance
    name: example
    properties:
      clusterIdentifier: ${example.id}
      instanceClass: db.serverless
      engine: ${example.engine}
      engineVersion: ${example.engineVersion}

RDS/Aurora Managed Master Passwords via Secrets Manager, default KMS Key

More information about RDS/Aurora Aurora integrates with Secrets Manager to manage master user passwords for your DB clusters can be found in the RDS User Guide and Aurora User Guide.

You can specify the manage_master_user_password attribute to enable managing the master password with Secrets Manager. You can also update an existing cluster to use Secrets Manager by specify the manage_master_user_password attribute and removing the master_password attribute (removal is required).

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

const test = new aws.rds.Cluster("test", {
    clusterIdentifier: "example",
    databaseName: "test",
    manageMasterUserPassword: true,
    masterUsername: "test",
});

import pulumi
import pulumi_aws as aws

test = aws.rds.Cluster("test",
    cluster_identifier="example",
    database_name="test",
    manage_master_user_password=True,
    master_username="test")

package main

import (
	"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 {
		_, err := rds.NewCluster(ctx, "test", &rds.ClusterArgs{
			ClusterIdentifier:        pulumi.String("example"),
			DatabaseName:             pulumi.String("test"),
			ManageMasterUserPassword: pulumi.Bool(true),
			MasterUsername:           pulumi.String("test"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var test = new Aws.Rds.Cluster("test", new()
    {
        ClusterIdentifier = "example",
        DatabaseName = "test",
        ManageMasterUserPassword = true,
        MasterUsername = "test",
    });

});

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 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 test = new Cluster("test", ClusterArgs.builder()
            .clusterIdentifier("example")
            .databaseName("test")
            .manageMasterUserPassword(true)
            .masterUsername("test")
            .build());

    }
}

resources:
  test:
    type: aws:rds:Cluster
    properties:
      clusterIdentifier: example
      databaseName: test
      manageMasterUserPassword: true
      masterUsername: test

RDS/Aurora Managed Master Passwords via Secrets Manager, specific KMS Key

More information about RDS/Aurora Aurora integrates with Secrets Manager to manage master user passwords for your DB clusters can be found in the RDS User Guide and Aurora User Guide.

You can specify the master_user_secret_kms_key_id attribute to specify a specific KMS Key.

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

const example = new aws.kms.Key("example", {description: "Example KMS Key"});
const test = new aws.rds.Cluster("test", {
    clusterIdentifier: "example",
    databaseName: "test",
    manageMasterUserPassword: true,
    masterUsername: "test",
    masterUserSecretKmsKeyId: example.keyId,
});

import pulumi
import pulumi_aws as aws

example = aws.kms.Key("example", description="Example KMS Key")
test = aws.rds.Cluster("test",
    cluster_identifier="example",
    database_name="test",
    manage_master_user_password=True,
    master_username="test",
    master_user_secret_kms_key_id=example.key_id)

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/kms"
	"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 {
		example, err := kms.NewKey(ctx, "example", &kms.KeyArgs{
			Description: pulumi.String("Example KMS Key"),
		})
		if err != nil {
			return err
		}
		_, err = rds.NewCluster(ctx, "test", &rds.ClusterArgs{
			ClusterIdentifier:        pulumi.String("example"),
			DatabaseName:             pulumi.String("test"),
			ManageMasterUserPassword: pulumi.Bool(true),
			MasterUsername:           pulumi.String("test"),
			MasterUserSecretKmsKeyId: example.KeyId,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Kms.Key("example", new()
    {
        Description = "Example KMS Key",
    });

    var test = new Aws.Rds.Cluster("test", new()
    {
        ClusterIdentifier = "example",
        DatabaseName = "test",
        ManageMasterUserPassword = true,
        MasterUsername = "test",
        MasterUserSecretKmsKeyId = example.KeyId,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.kms.Key;
import com.pulumi.aws.kms.KeyArgs;
import com.pulumi.aws.rds.Cluster;
import com.pulumi.aws.rds.ClusterArgs;
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 example = new Key("example", KeyArgs.builder()
            .description("Example KMS Key")
            .build());

        var test = new Cluster("test", ClusterArgs.builder()
            .clusterIdentifier("example")
            .databaseName("test")
            .manageMasterUserPassword(true)
            .masterUsername("test")
            .masterUserSecretKmsKeyId(example.keyId())
            .build());

    }
}

resources:
  example:
    type: aws:kms:Key
    properties:
      description: Example KMS Key
  test:
    type: aws:rds:Cluster
    properties:
      clusterIdentifier: example
      databaseName: test
      manageMasterUserPassword: true
      masterUsername: test
      masterUserSecretKmsKeyId: ${example.keyId}

Global Cluster Restored From Snapshot

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

const example = aws.rds.getClusterSnapshot({
    dbClusterIdentifier: "example-original-cluster",
    mostRecent: true,
});
const exampleCluster = new aws.rds.Cluster("example", {
    engine: aws.rds.EngineType.Aurora,
    engineVersion: "5.6.mysql_aurora.1.22.4",
    clusterIdentifier: "example",
    snapshotIdentifier: example.then(example => example.id),
});
const exampleGlobalCluster = new aws.rds.GlobalCluster("example", {
    globalClusterIdentifier: "example",
    sourceDbClusterIdentifier: exampleCluster.arn,
    forceDestroy: true,
});

import pulumi
import pulumi_aws as aws

example = aws.rds.get_cluster_snapshot(db_cluster_identifier="example-original-cluster",
    most_recent=True)
example_cluster = aws.rds.Cluster("example",
    engine=aws.rds.EngineType.AURORA,
    engine_version="5.6.mysql_aurora.1.22.4",
    cluster_identifier="example",
    snapshot_identifier=example.id)
example_global_cluster = aws.rds.GlobalCluster("example",
    global_cluster_identifier="example",
    source_db_cluster_identifier=example_cluster.arn,
    force_destroy=True)

package main

import (
	"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 {
		example, err := rds.LookupClusterSnapshot(ctx, &rds.LookupClusterSnapshotArgs{
			DbClusterIdentifier: pulumi.StringRef("example-original-cluster"),
			MostRecent:          pulumi.BoolRef(true),
		}, nil)
		if err != nil {
			return err
		}
		exampleCluster, err := rds.NewCluster(ctx, "example", &rds.ClusterArgs{
			Engine:             pulumi.String(rds.EngineTypeAurora),
			EngineVersion:      pulumi.String("5.6.mysql_aurora.1.22.4"),
			ClusterIdentifier:  pulumi.String("example"),
			SnapshotIdentifier: pulumi.String(example.Id),
		})
		if err != nil {
			return err
		}
		_, err = rds.NewGlobalCluster(ctx, "example", &rds.GlobalClusterArgs{
			GlobalClusterIdentifier:   pulumi.String("example"),
			SourceDbClusterIdentifier: exampleCluster.Arn,
			ForceDestroy:              pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Aws.Rds.GetClusterSnapshot.Invoke(new()
    {
        DbClusterIdentifier = "example-original-cluster",
        MostRecent = true,
    });

    var exampleCluster = new Aws.Rds.Cluster("example", new()
    {
        Engine = Aws.Rds.EngineType.Aurora,
        EngineVersion = "5.6.mysql_aurora.1.22.4",
        ClusterIdentifier = "example",
        SnapshotIdentifier = example.Apply(getClusterSnapshotResult => getClusterSnapshotResult.Id),
    });

    var exampleGlobalCluster = new Aws.Rds.GlobalCluster("example", new()
    {
        GlobalClusterIdentifier = "example",
        SourceDbClusterIdentifier = exampleCluster.Arn,
        ForceDestroy = true,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.rds.RdsFunctions;
import com.pulumi.aws.rds.inputs.GetClusterSnapshotArgs;
import com.pulumi.aws.rds.Cluster;
import com.pulumi.aws.rds.ClusterArgs;
import com.pulumi.aws.rds.GlobalCluster;
import com.pulumi.aws.rds.GlobalClusterArgs;
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) {
        final var example = RdsFunctions.getClusterSnapshot(GetClusterSnapshotArgs.builder()
            .dbClusterIdentifier("example-original-cluster")
            .mostRecent(true)
            .build());

        var exampleCluster = new Cluster("exampleCluster", ClusterArgs.builder()
            .engine("aurora")
            .engineVersion("5.6.mysql_aurora.1.22.4")
            .clusterIdentifier("example")
            .snapshotIdentifier(example.applyValue(getClusterSnapshotResult -> getClusterSnapshotResult.id()))
            .build());

        var exampleGlobalCluster = new GlobalCluster("exampleGlobalCluster", GlobalClusterArgs.builder()
            .globalClusterIdentifier("example")
            .sourceDbClusterIdentifier(exampleCluster.arn())
            .forceDestroy(true)
            .build());

    }
}

resources:
  exampleCluster:
    type: aws:rds:Cluster
    name: example
    properties:
      engine: aurora
      engineVersion: 5.6.mysql_aurora.1.22.4
      clusterIdentifier: example
      snapshotIdentifier: ${example.id}
  exampleGlobalCluster:
    type: aws:rds:GlobalCluster
    name: example
    properties:
      globalClusterIdentifier: example
      sourceDbClusterIdentifier: ${exampleCluster.arn}
      forceDestroy: true
variables:
  example:
    fn::invoke:
      Function: aws:rds:getClusterSnapshot
      Arguments:
        dbClusterIdentifier: example-original-cluster
        mostRecent: true

Create Cluster Resource

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

Constructor syntax

new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);

@overload
def Cluster(resource_name: str,
            args: ClusterArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Cluster(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            engine: Optional[Union[str, EngineType]] = None,
            allocated_storage: Optional[int] = None,
            allow_major_version_upgrade: Optional[bool] = None,
            apply_immediately: Optional[bool] = None,
            availability_zones: Optional[Sequence[str]] = None,
            backtrack_window: Optional[int] = None,
            backup_retention_period: Optional[int] = None,
            ca_certificate_identifier: Optional[str] = None,
            cluster_identifier: Optional[str] = None,
            cluster_identifier_prefix: Optional[str] = None,
            cluster_members: Optional[Sequence[str]] = None,
            copy_tags_to_snapshot: Optional[bool] = None,
            database_name: Optional[str] = None,
            db_cluster_instance_class: Optional[str] = None,
            db_cluster_parameter_group_name: Optional[str] = None,
            db_instance_parameter_group_name: Optional[str] = None,
            db_subnet_group_name: Optional[str] = None,
            db_system_id: Optional[str] = None,
            delete_automated_backups: Optional[bool] = None,
            deletion_protection: Optional[bool] = None,
            domain: Optional[str] = None,
            domain_iam_role_name: Optional[str] = None,
            enable_global_write_forwarding: Optional[bool] = None,
            enable_http_endpoint: Optional[bool] = None,
            enable_local_write_forwarding: Optional[bool] = None,
            enabled_cloudwatch_logs_exports: Optional[Sequence[str]] = None,
            engine_lifecycle_support: Optional[str] = None,
            engine_mode: Optional[Union[str, EngineMode]] = None,
            engine_version: Optional[str] = None,
            final_snapshot_identifier: Optional[str] = None,
            global_cluster_identifier: Optional[str] = None,
            iam_database_authentication_enabled: Optional[bool] = None,
            iam_roles: Optional[Sequence[str]] = None,
            iops: Optional[int] = None,
            kms_key_id: Optional[str] = None,
            manage_master_user_password: Optional[bool] = None,
            master_password: Optional[str] = None,
            master_user_secret_kms_key_id: Optional[str] = None,
            master_username: 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,
            replication_source_identifier: Optional[str] = None,
            restore_to_point_in_time: Optional[ClusterRestoreToPointInTimeArgs] = None,
            s3_import: Optional[ClusterS3ImportArgs] = None,
            scaling_configuration: Optional[ClusterScalingConfigurationArgs] = None,
            serverlessv2_scaling_configuration: Optional[ClusterServerlessv2ScalingConfigurationArgs] = None,
            skip_final_snapshot: Optional[bool] = None,
            snapshot_identifier: Optional[str] = None,
            source_region: Optional[str] = None,
            storage_encrypted: Optional[bool] = None,
            storage_type: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            vpc_security_group_ids: Optional[Sequence[str]] = None)

func NewCluster(ctx *Context, name string, args ClusterArgs, opts ...ResourceOption) (*Cluster, error)

public Cluster(string name, ClusterArgs args, CustomResourceOptions? opts = null)

public Cluster(String name, ClusterArgs args)
public Cluster(String name, ClusterArgs args, CustomResourceOptions options)

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

Parameters

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

resource_name str: The unique name of the resource.
args ClusterArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

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

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

name String: The unique name of the resource.
args ClusterArgs: 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 exampleclusterResourceResourceFromRdscluster = new Aws.Rds.Cluster("exampleclusterResourceResourceFromRdscluster", new()
{
    Engine = "string",
    AllocatedStorage = 0,
    AllowMajorVersionUpgrade = false,
    ApplyImmediately = false,
    AvailabilityZones = new[]
    {
        "string",
    },
    BacktrackWindow = 0,
    BackupRetentionPeriod = 0,
    CaCertificateIdentifier = "string",
    ClusterIdentifier = "string",
    ClusterIdentifierPrefix = "string",
    ClusterMembers = new[]
    {
        "string",
    },
    CopyTagsToSnapshot = false,
    DatabaseName = "string",
    DbClusterInstanceClass = "string",
    DbClusterParameterGroupName = "string",
    DbInstanceParameterGroupName = "string",
    DbSubnetGroupName = "string",
    DbSystemId = "string",
    DeleteAutomatedBackups = false,
    DeletionProtection = false,
    Domain = "string",
    DomainIamRoleName = "string",
    EnableGlobalWriteForwarding = false,
    EnableHttpEndpoint = false,
    EnableLocalWriteForwarding = false,
    EnabledCloudwatchLogsExports = new[]
    {
        "string",
    },
    EngineLifecycleSupport = "string",
    EngineMode = "string",
    EngineVersion = "string",
    FinalSnapshotIdentifier = "string",
    GlobalClusterIdentifier = "string",
    IamDatabaseAuthenticationEnabled = false,
    IamRoles = new[]
    {
        "string",
    },
    Iops = 0,
    KmsKeyId = "string",
    ManageMasterUserPassword = false,
    MasterPassword = "string",
    MasterUserSecretKmsKeyId = "string",
    MasterUsername = "string",
    NetworkType = "string",
    PerformanceInsightsEnabled = false,
    PerformanceInsightsKmsKeyId = "string",
    PerformanceInsightsRetentionPeriod = 0,
    Port = 0,
    PreferredBackupWindow = "string",
    PreferredMaintenanceWindow = "string",
    ReplicationSourceIdentifier = "string",
    RestoreToPointInTime = new Aws.Rds.Inputs.ClusterRestoreToPointInTimeArgs
    {
        RestoreToTime = "string",
        RestoreType = "string",
        SourceClusterIdentifier = "string",
        SourceClusterResourceId = "string",
        UseLatestRestorableTime = false,
    },
    S3Import = new Aws.Rds.Inputs.ClusterS3ImportArgs
    {
        BucketName = "string",
        IngestionRole = "string",
        SourceEngine = "string",
        SourceEngineVersion = "string",
        BucketPrefix = "string",
    },
    ScalingConfiguration = new Aws.Rds.Inputs.ClusterScalingConfigurationArgs
    {
        AutoPause = false,
        MaxCapacity = 0,
        MinCapacity = 0,
        SecondsBeforeTimeout = 0,
        SecondsUntilAutoPause = 0,
        TimeoutAction = "string",
    },
    Serverlessv2ScalingConfiguration = new Aws.Rds.Inputs.ClusterServerlessv2ScalingConfigurationArgs
    {
        MaxCapacity = 0,
        MinCapacity = 0,
    },
    SkipFinalSnapshot = false,
    SnapshotIdentifier = "string",
    SourceRegion = "string",
    StorageEncrypted = false,
    StorageType = "string",
    Tags = 
    {
        { "string", "string" },
    },
    VpcSecurityGroupIds = new[]
    {
        "string",
    },
});

example, err := rds.NewCluster(ctx, "exampleclusterResourceResourceFromRdscluster", &rds.ClusterArgs{
	Engine:                   pulumi.String("string"),
	AllocatedStorage:         pulumi.Int(0),
	AllowMajorVersionUpgrade: pulumi.Bool(false),
	ApplyImmediately:         pulumi.Bool(false),
	AvailabilityZones: pulumi.StringArray{
		pulumi.String("string"),
	},
	BacktrackWindow:         pulumi.Int(0),
	BackupRetentionPeriod:   pulumi.Int(0),
	CaCertificateIdentifier: pulumi.String("string"),
	ClusterIdentifier:       pulumi.String("string"),
	ClusterIdentifierPrefix: pulumi.String("string"),
	ClusterMembers: pulumi.StringArray{
		pulumi.String("string"),
	},
	CopyTagsToSnapshot:           pulumi.Bool(false),
	DatabaseName:                 pulumi.String("string"),
	DbClusterInstanceClass:       pulumi.String("string"),
	DbClusterParameterGroupName:  pulumi.String("string"),
	DbInstanceParameterGroupName: pulumi.String("string"),
	DbSubnetGroupName:            pulumi.String("string"),
	DbSystemId:                   pulumi.String("string"),
	DeleteAutomatedBackups:       pulumi.Bool(false),
	DeletionProtection:           pulumi.Bool(false),
	Domain:                       pulumi.String("string"),
	DomainIamRoleName:            pulumi.String("string"),
	EnableGlobalWriteForwarding:  pulumi.Bool(false),
	EnableHttpEndpoint:           pulumi.Bool(false),
	EnableLocalWriteForwarding:   pulumi.Bool(false),
	EnabledCloudwatchLogsExports: pulumi.StringArray{
		pulumi.String("string"),
	},
	EngineLifecycleSupport:           pulumi.String("string"),
	EngineMode:                       pulumi.String("string"),
	EngineVersion:                    pulumi.String("string"),
	FinalSnapshotIdentifier:          pulumi.String("string"),
	GlobalClusterIdentifier:          pulumi.String("string"),
	IamDatabaseAuthenticationEnabled: pulumi.Bool(false),
	IamRoles: pulumi.StringArray{
		pulumi.String("string"),
	},
	Iops:                               pulumi.Int(0),
	KmsKeyId:                           pulumi.String("string"),
	ManageMasterUserPassword:           pulumi.Bool(false),
	MasterPassword:                     pulumi.String("string"),
	MasterUserSecretKmsKeyId:           pulumi.String("string"),
	MasterUsername:                     pulumi.String("string"),
	NetworkType:                        pulumi.String("string"),
	PerformanceInsightsEnabled:         pulumi.Bool(false),
	PerformanceInsightsKmsKeyId:        pulumi.String("string"),
	PerformanceInsightsRetentionPeriod: pulumi.Int(0),
	Port:                               pulumi.Int(0),
	PreferredBackupWindow:              pulumi.String("string"),
	PreferredMaintenanceWindow:         pulumi.String("string"),
	ReplicationSourceIdentifier:        pulumi.String("string"),
	RestoreToPointInTime: &rds.ClusterRestoreToPointInTimeArgs{
		RestoreToTime:           pulumi.String("string"),
		RestoreType:             pulumi.String("string"),
		SourceClusterIdentifier: pulumi.String("string"),
		SourceClusterResourceId: pulumi.String("string"),
		UseLatestRestorableTime: pulumi.Bool(false),
	},
	S3Import: &rds.ClusterS3ImportArgs{
		BucketName:          pulumi.String("string"),
		IngestionRole:       pulumi.String("string"),
		SourceEngine:        pulumi.String("string"),
		SourceEngineVersion: pulumi.String("string"),
		BucketPrefix:        pulumi.String("string"),
	},
	ScalingConfiguration: &rds.ClusterScalingConfigurationArgs{
		AutoPause:             pulumi.Bool(false),
		MaxCapacity:           pulumi.Int(0),
		MinCapacity:           pulumi.Int(0),
		SecondsBeforeTimeout:  pulumi.Int(0),
		SecondsUntilAutoPause: pulumi.Int(0),
		TimeoutAction:         pulumi.String("string"),
	},
	Serverlessv2ScalingConfiguration: &rds.ClusterServerlessv2ScalingConfigurationArgs{
		MaxCapacity: pulumi.Float64(0),
		MinCapacity: pulumi.Float64(0),
	},
	SkipFinalSnapshot:  pulumi.Bool(false),
	SnapshotIdentifier: pulumi.String("string"),
	SourceRegion:       pulumi.String("string"),
	StorageEncrypted:   pulumi.Bool(false),
	StorageType:        pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	VpcSecurityGroupIds: pulumi.StringArray{
		pulumi.String("string"),
	},
})

var exampleclusterResourceResourceFromRdscluster = new Cluster("exampleclusterResourceResourceFromRdscluster", ClusterArgs.builder()
    .engine("string")
    .allocatedStorage(0)
    .allowMajorVersionUpgrade(false)
    .applyImmediately(false)
    .availabilityZones("string")
    .backtrackWindow(0)
    .backupRetentionPeriod(0)
    .caCertificateIdentifier("string")
    .clusterIdentifier("string")
    .clusterIdentifierPrefix("string")
    .clusterMembers("string")
    .copyTagsToSnapshot(false)
    .databaseName("string")
    .dbClusterInstanceClass("string")
    .dbClusterParameterGroupName("string")
    .dbInstanceParameterGroupName("string")
    .dbSubnetGroupName("string")
    .dbSystemId("string")
    .deleteAutomatedBackups(false)
    .deletionProtection(false)
    .domain("string")
    .domainIamRoleName("string")
    .enableGlobalWriteForwarding(false)
    .enableHttpEndpoint(false)
    .enableLocalWriteForwarding(false)
    .enabledCloudwatchLogsExports("string")
    .engineLifecycleSupport("string")
    .engineMode("string")
    .engineVersion("string")
    .finalSnapshotIdentifier("string")
    .globalClusterIdentifier("string")
    .iamDatabaseAuthenticationEnabled(false)
    .iamRoles("string")
    .iops(0)
    .kmsKeyId("string")
    .manageMasterUserPassword(false)
    .masterPassword("string")
    .masterUserSecretKmsKeyId("string")
    .masterUsername("string")
    .networkType("string")
    .performanceInsightsEnabled(false)
    .performanceInsightsKmsKeyId("string")
    .performanceInsightsRetentionPeriod(0)
    .port(0)
    .preferredBackupWindow("string")
    .preferredMaintenanceWindow("string")
    .replicationSourceIdentifier("string")
    .restoreToPointInTime(ClusterRestoreToPointInTimeArgs.builder()
        .restoreToTime("string")
        .restoreType("string")
        .sourceClusterIdentifier("string")
        .sourceClusterResourceId("string")
        .useLatestRestorableTime(false)
        .build())
    .s3Import(ClusterS3ImportArgs.builder()
        .bucketName("string")
        .ingestionRole("string")
        .sourceEngine("string")
        .sourceEngineVersion("string")
        .bucketPrefix("string")
        .build())
    .scalingConfiguration(ClusterScalingConfigurationArgs.builder()
        .autoPause(false)
        .maxCapacity(0)
        .minCapacity(0)
        .secondsBeforeTimeout(0)
        .secondsUntilAutoPause(0)
        .timeoutAction("string")
        .build())
    .serverlessv2ScalingConfiguration(ClusterServerlessv2ScalingConfigurationArgs.builder()
        .maxCapacity(0)
        .minCapacity(0)
        .build())
    .skipFinalSnapshot(false)
    .snapshotIdentifier("string")
    .sourceRegion("string")
    .storageEncrypted(false)
    .storageType("string")
    .tags(Map.of("string", "string"))
    .vpcSecurityGroupIds("string")
    .build());

examplecluster_resource_resource_from_rdscluster = aws.rds.Cluster("exampleclusterResourceResourceFromRdscluster",
    engine="string",
    allocated_storage=0,
    allow_major_version_upgrade=False,
    apply_immediately=False,
    availability_zones=["string"],
    backtrack_window=0,
    backup_retention_period=0,
    ca_certificate_identifier="string",
    cluster_identifier="string",
    cluster_identifier_prefix="string",
    cluster_members=["string"],
    copy_tags_to_snapshot=False,
    database_name="string",
    db_cluster_instance_class="string",
    db_cluster_parameter_group_name="string",
    db_instance_parameter_group_name="string",
    db_subnet_group_name="string",
    db_system_id="string",
    delete_automated_backups=False,
    deletion_protection=False,
    domain="string",
    domain_iam_role_name="string",
    enable_global_write_forwarding=False,
    enable_http_endpoint=False,
    enable_local_write_forwarding=False,
    enabled_cloudwatch_logs_exports=["string"],
    engine_lifecycle_support="string",
    engine_mode="string",
    engine_version="string",
    final_snapshot_identifier="string",
    global_cluster_identifier="string",
    iam_database_authentication_enabled=False,
    iam_roles=["string"],
    iops=0,
    kms_key_id="string",
    manage_master_user_password=False,
    master_password="string",
    master_user_secret_kms_key_id="string",
    master_username="string",
    network_type="string",
    performance_insights_enabled=False,
    performance_insights_kms_key_id="string",
    performance_insights_retention_period=0,
    port=0,
    preferred_backup_window="string",
    preferred_maintenance_window="string",
    replication_source_identifier="string",
    restore_to_point_in_time={
        "restoreToTime": "string",
        "restoreType": "string",
        "sourceClusterIdentifier": "string",
        "sourceClusterResourceId": "string",
        "useLatestRestorableTime": False,
    },
    s3_import={
        "bucketName": "string",
        "ingestionRole": "string",
        "sourceEngine": "string",
        "sourceEngineVersion": "string",
        "bucketPrefix": "string",
    },
    scaling_configuration={
        "autoPause": False,
        "maxCapacity": 0,
        "minCapacity": 0,
        "secondsBeforeTimeout": 0,
        "secondsUntilAutoPause": 0,
        "timeoutAction": "string",
    },
    serverlessv2_scaling_configuration={
        "maxCapacity": 0,
        "minCapacity": 0,
    },
    skip_final_snapshot=False,
    snapshot_identifier="string",
    source_region="string",
    storage_encrypted=False,
    storage_type="string",
    tags={
        "string": "string",
    },
    vpc_security_group_ids=["string"])

const exampleclusterResourceResourceFromRdscluster = new aws.rds.Cluster("exampleclusterResourceResourceFromRdscluster", {
    engine: "string",
    allocatedStorage: 0,
    allowMajorVersionUpgrade: false,
    applyImmediately: false,
    availabilityZones: ["string"],
    backtrackWindow: 0,
    backupRetentionPeriod: 0,
    caCertificateIdentifier: "string",
    clusterIdentifier: "string",
    clusterIdentifierPrefix: "string",
    clusterMembers: ["string"],
    copyTagsToSnapshot: false,
    databaseName: "string",
    dbClusterInstanceClass: "string",
    dbClusterParameterGroupName: "string",
    dbInstanceParameterGroupName: "string",
    dbSubnetGroupName: "string",
    dbSystemId: "string",
    deleteAutomatedBackups: false,
    deletionProtection: false,
    domain: "string",
    domainIamRoleName: "string",
    enableGlobalWriteForwarding: false,
    enableHttpEndpoint: false,
    enableLocalWriteForwarding: false,
    enabledCloudwatchLogsExports: ["string"],
    engineLifecycleSupport: "string",
    engineMode: "string",
    engineVersion: "string",
    finalSnapshotIdentifier: "string",
    globalClusterIdentifier: "string",
    iamDatabaseAuthenticationEnabled: false,
    iamRoles: ["string"],
    iops: 0,
    kmsKeyId: "string",
    manageMasterUserPassword: false,
    masterPassword: "string",
    masterUserSecretKmsKeyId: "string",
    masterUsername: "string",
    networkType: "string",
    performanceInsightsEnabled: false,
    performanceInsightsKmsKeyId: "string",
    performanceInsightsRetentionPeriod: 0,
    port: 0,
    preferredBackupWindow: "string",
    preferredMaintenanceWindow: "string",
    replicationSourceIdentifier: "string",
    restoreToPointInTime: {
        restoreToTime: "string",
        restoreType: "string",
        sourceClusterIdentifier: "string",
        sourceClusterResourceId: "string",
        useLatestRestorableTime: false,
    },
    s3Import: {
        bucketName: "string",
        ingestionRole: "string",
        sourceEngine: "string",
        sourceEngineVersion: "string",
        bucketPrefix: "string",
    },
    scalingConfiguration: {
        autoPause: false,
        maxCapacity: 0,
        minCapacity: 0,
        secondsBeforeTimeout: 0,
        secondsUntilAutoPause: 0,
        timeoutAction: "string",
    },
    serverlessv2ScalingConfiguration: {
        maxCapacity: 0,
        minCapacity: 0,
    },
    skipFinalSnapshot: false,
    snapshotIdentifier: "string",
    sourceRegion: "string",
    storageEncrypted: false,
    storageType: "string",
    tags: {
        string: "string",
    },
    vpcSecurityGroupIds: ["string"],
});

type: aws:rds:Cluster
properties:
    allocatedStorage: 0
    allowMajorVersionUpgrade: false
    applyImmediately: false
    availabilityZones:
        - string
    backtrackWindow: 0
    backupRetentionPeriod: 0
    caCertificateIdentifier: string
    clusterIdentifier: string
    clusterIdentifierPrefix: string
    clusterMembers:
        - string
    copyTagsToSnapshot: false
    databaseName: string
    dbClusterInstanceClass: string
    dbClusterParameterGroupName: string
    dbInstanceParameterGroupName: string
    dbSubnetGroupName: string
    dbSystemId: string
    deleteAutomatedBackups: false
    deletionProtection: false
    domain: string
    domainIamRoleName: string
    enableGlobalWriteForwarding: false
    enableHttpEndpoint: false
    enableLocalWriteForwarding: false
    enabledCloudwatchLogsExports:
        - string
    engine: string
    engineLifecycleSupport: string
    engineMode: string
    engineVersion: string
    finalSnapshotIdentifier: string
    globalClusterIdentifier: string
    iamDatabaseAuthenticationEnabled: false
    iamRoles:
        - string
    iops: 0
    kmsKeyId: string
    manageMasterUserPassword: false
    masterPassword: string
    masterUserSecretKmsKeyId: string
    masterUsername: string
    networkType: string
    performanceInsightsEnabled: false
    performanceInsightsKmsKeyId: string
    performanceInsightsRetentionPeriod: 0
    port: 0
    preferredBackupWindow: string
    preferredMaintenanceWindow: string
    replicationSourceIdentifier: string
    restoreToPointInTime:
        restoreToTime: string
        restoreType: string
        sourceClusterIdentifier: string
        sourceClusterResourceId: string
        useLatestRestorableTime: false
    s3Import:
        bucketName: string
        bucketPrefix: string
        ingestionRole: string
        sourceEngine: string
        sourceEngineVersion: string
    scalingConfiguration:
        autoPause: false
        maxCapacity: 0
        minCapacity: 0
        secondsBeforeTimeout: 0
        secondsUntilAutoPause: 0
        timeoutAction: string
    serverlessv2ScalingConfiguration:
        maxCapacity: 0
        minCapacity: 0
    skipFinalSnapshot: false
    snapshotIdentifier: string
    sourceRegion: string
    storageEncrypted: false
    storageType: string
    tags:
        string: string
    vpcSecurityGroupIds:
        - string

Cluster Resource Properties

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

Inputs

The Cluster resource accepts the following input properties:

Engine string | Pulumi.Aws.Rds.EngineType: Name of the database engine to be used for this DB cluster. Valid Values: aurora-mysql, aurora-postgresql, mysql, postgres. (Note that mysql and postgres are Multi-AZ RDS clusters).
AllocatedStorage int: The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
AllowMajorVersionUpgrade bool: Enable to allow major engine version upgrades when changing engine versions. Defaults to false.
ApplyImmediately bool: Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.
AvailabilityZones List<string>: List of EC2 Availability Zones for the DB cluster storage where DB cluster instances can be created. RDS automatically assigns 3 AZs if less than 3 AZs are configured, which will show as a difference requiring resource recreation next pulumi up. We recommend specifying 3 AZs or using the lifecycle configuration block ignore_changes argument if necessary. A maximum of 3 AZs can be configured.
BacktrackWindow int: Target backtrack window, in seconds. Only available for aurora and aurora-mysql engines currently. To disable backtracking, set this value to 0. Defaults to 0. Must be between 0 and 259200 (72 hours)
BackupRetentionPeriod int: Days to retain backups for. Default 1
CaCertificateIdentifier string: The CA certificate identifier to use for the DB cluster's server certificate.
ClusterIdentifier string: The cluster identifier. If omitted, this provider will assign a random, unique identifier.
ClusterIdentifierPrefix string: Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
ClusterMembers List<string>: List of RDS Instances that are a part of this cluster
CopyTagsToSnapshot bool: Copy all Cluster tags to snapshots. Default is false.
DatabaseName string: Name for an automatically created database on cluster creation. There are different naming restrictions per database engine: RDS Naming Constraints
DbClusterInstanceClass string: The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide.
DbClusterParameterGroupName string: A cluster parameter group to associate with the cluster.
DbInstanceParameterGroupName string: Instance parameter group to associate with all instances of the DB cluster. The db_instance_parameter_group_name parameter is only valid in combination with the allow_major_version_upgrade parameter.
DbSubnetGroupName string: DB subnet group to associate with this DB cluster. NOTE: This must match the db_subnet_group_name specified on every aws.rds.ClusterInstance in the cluster.
DbSystemId string: For use with RDS Custom.
DeleteAutomatedBackups bool: Specifies whether to remove automated backups immediately after the DB cluster is deleted. Default is true.
DeletionProtection bool: If the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.
Domain string: The ID of the Directory Service Active Directory domain to create the cluster in.
DomainIamRoleName string: The name of the IAM role to be used when making API calls to the Directory Service.
EnableGlobalWriteForwarding bool: Whether cluster should forward writes to an associated global cluster. Applied to secondary clusters to enable them to forward writes to an aws.rds.GlobalCluster's primary cluster. See the User Guide for Aurora for more information.
EnableHttpEndpoint bool: Enable HTTP endpoint (data API). Only valid for some combinations of engine_mode, engine and engine_version and only available in some regions. See the Region and version availability section of the documentation. This option also does not work with any of these options specified: snapshot_identifier, replication_source_identifier, s3_import.
EnableLocalWriteForwarding bool: Whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.. See the User Guide for Aurora for more information. NOTE: Local write forwarding requires Aurora MySQL version 3.04 or higher.
EnabledCloudwatchLogsExports List<string>: Set of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, error, general, slowquery, postgresql (PostgreSQL).
EngineLifecycleSupport string: The life cycle type for this DB instance. This setting is valid for cluster types Aurora DB clusters and Multi-AZ DB clusters. Valid values are open-source-rds-extended-support, open-source-rds-extended-support-disabled. Default value is open-source-rds-extended-support. [Using Amazon RDS Extended Support]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html
EngineMode string | Pulumi.Aws.Rds.EngineMode: Database engine mode. Valid values: global (only valid for Aurora MySQL 1.21 and earlier), parallelquery, provisioned, serverless. Defaults to: provisioned. See the RDS User Guide for limitations when using serverless.
EngineVersion string: Database engine version. Updating this argument results in an outage. See the Aurora MySQL and Aurora Postgres documentation for your configured engine to determine this value, or by running aws rds describe-db-engine-versions. For example with Aurora MySQL 2, a potential value for this argument is 5.7.mysql_aurora.2.03.2. The value can contain a partial version where supported by the API. The actual engine version used is returned in the attribute engine_version_actual, , see Attribute Reference below.
FinalSnapshotIdentifier string: Name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
GlobalClusterIdentifier string: Global cluster identifier specified on aws.rds.GlobalCluster.
IamDatabaseAuthenticationEnabled bool: Specifies whether or not mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Please see AWS Documentation for availability and limitations.
IamRoles List<string>: List of ARNs for the IAM roles to associate to the RDS Cluster.
Iops int: Amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. For information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide. (This setting is required to create a Multi-AZ DB cluster). Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
KmsKeyId string: ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.
ManageMasterUserPassword bool: Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if master_password is provided.
MasterPassword string: Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the RDS Naming Constraints. Cannot be set if manage_master_user_password is set to true.
MasterUserSecretKmsKeyId string: Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. If not specified, the default KMS key for your Amazon Web Services account is used.
MasterUsername string: Username for the master DB user. Please refer to the RDS Naming Constraints. This argument does not support in-place updates and cannot be changed during a restore from snapshot.
NetworkType string: Network type of the cluster. Valid values: IPV4, DUAL.
PerformanceInsightsEnabled bool: Valid only for Non-Aurora Multi-AZ DB Clusters. Enables Performance Insights for the RDS Cluster
PerformanceInsightsKmsKeyId string: Valid only for Non-Aurora Multi-AZ DB Clusters. Specifies the KMS Key ID to encrypt Performance Insights data. If not specified, the default RDS KMS key will be used (aws/rds).
PerformanceInsightsRetentionPeriod int: Valid only for Non-Aurora Multi-AZ DB Clusters. Specifies the amount of time to retain performance insights data for. Defaults to 7 days if Performance Insights are enabled. Valid values are 7, month * 31 (where month is a number of months from 1-23), and 731. See here for more information on retention periods.
Port int: Port on which the DB accepts connections.
PreferredBackupWindow string: Daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC. Default: A 30-minute window selected at random from an 8-hour block of time per region, e.g. 04:00-09:00.
PreferredMaintenanceWindow string: Weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
ReplicationSourceIdentifier string: ARN of a source DB cluster or DB instance if this DB cluster is to be created as a Read Replica. If DB Cluster is part of a Global Cluster, use the lifecycle configuration block ignore_changes argument to prevent this provider from showing differences for this argument instead of configuring this value.
RestoreToPointInTime ClusterRestoreToPointInTime: Nested attribute for point in time restore. More details below.
S3Import ClusterS3Import
ScalingConfiguration ClusterScalingConfiguration: Nested attribute with scaling properties. Only valid when engine_mode is set to serverless. More details below.
Serverlessv2ScalingConfiguration ClusterServerlessv2ScalingConfiguration: Nested attribute with scaling properties for ServerlessV2. Only valid when engine_mode is set to provisioned. More details below.
SkipFinalSnapshot bool: Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from final_snapshot_identifier. Default is false.
SnapshotIdentifier string: Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot. Conflicts with global_cluster_identifier. Clusters cannot be restored from snapshot and joined to an existing global cluster in a single operation. See the AWS documentation or the Global Cluster Restored From Snapshot example for instructions on building a global cluster starting with a snapshot.
SourceRegion string: The source region for an encrypted replica DB cluster.
StorageEncrypted bool: Specifies whether the DB cluster is encrypted. The default is false for provisioned engine_mode and true for serverless engine_mode. When restoring an unencrypted snapshot_identifier, the kms_key_id argument must be provided to encrypt the restored cluster. The provider will only perform drift detection if a configuration value is provided.
StorageType string: (Forces new for Multi-AZ DB clusters) Specifies the storage type to be associated with the DB cluster. For Aurora DB clusters, storage_type modifications can be done in-place. For Multi-AZ DB Clusters, the iops argument must also be set. Valid values are: "", aurora-iopt1 (Aurora DB Clusters); io1, io2 (Multi-AZ DB Clusters). Default: "" (Aurora DB Clusters); io1 (Multi-AZ DB Clusters).
Tags Dictionary<string, string>: A map of tags to assign to the DB cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
VpcSecurityGroupIds List<string>: List of VPC security groups to associate with the Cluster

Engine string | EngineType: Name of the database engine to be used for this DB cluster. Valid Values: aurora-mysql, aurora-postgresql, mysql, postgres. (Note that mysql and postgres are Multi-AZ RDS clusters).
AllocatedStorage int: The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
AllowMajorVersionUpgrade bool: Enable to allow major engine version upgrades when changing engine versions. Defaults to false.
ApplyImmediately bool: Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.
AvailabilityZones []string: List of EC2 Availability Zones for the DB cluster storage where DB cluster instances can be created. RDS automatically assigns 3 AZs if less than 3 AZs are configured, which will show as a difference requiring resource recreation next pulumi up. We recommend specifying 3 AZs or using the lifecycle configuration block ignore_changes argument if necessary. A maximum of 3 AZs can be configured.
BacktrackWindow int: Target backtrack window, in seconds. Only available for aurora and aurora-mysql engines currently. To disable backtracking, set this value to 0. Defaults to 0. Must be between 0 and 259200 (72 hours)
BackupRetentionPeriod int: Days to retain backups for. Default 1
CaCertificateIdentifier string: The CA certificate identifier to use for the DB cluster's server certificate.
ClusterIdentifier string: The cluster identifier. If omitted, this provider will assign a random, unique identifier.
ClusterIdentifierPrefix string: Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
ClusterMembers []string: List of RDS Instances that are a part of this cluster
CopyTagsToSnapshot bool: Copy all Cluster tags to snapshots. Default is false.
DatabaseName string: Name for an automatically created database on cluster creation. There are different naming restrictions per database engine: RDS Naming Constraints
DbClusterInstanceClass string: The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide.
DbClusterParameterGroupName string: A cluster parameter group to associate with the cluster.
DbInstanceParameterGroupName string: Instance parameter group to associate with all instances of the DB cluster. The db_instance_parameter_group_name parameter is only valid in combination with the allow_major_version_upgrade parameter.
DbSubnetGroupName string: DB subnet group to associate with this DB cluster. NOTE: This must match the db_subnet_group_name specified on every aws.rds.ClusterInstance in the cluster.
DbSystemId string: For use with RDS Custom.
DeleteAutomatedBackups bool: Specifies whether to remove automated backups immediately after the DB cluster is deleted. Default is true.
DeletionProtection bool: If the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.
Domain string: The ID of the Directory Service Active Directory domain to create the cluster in.
DomainIamRoleName string: The name of the IAM role to be used when making API calls to the Directory Service.
EnableGlobalWriteForwarding bool: Whether cluster should forward writes to an associated global cluster. Applied to secondary clusters to enable them to forward writes to an aws.rds.GlobalCluster's primary cluster. See the User Guide for Aurora for more information.
EnableHttpEndpoint bool: Enable HTTP endpoint (data API). Only valid for some combinations of engine_mode, engine and engine_version and only available in some regions. See the Region and version availability section of the documentation. This option also does not work with any of these options specified: snapshot_identifier, replication_source_identifier, s3_import.
EnableLocalWriteForwarding bool: Whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.. See the User Guide for Aurora for more information. NOTE: Local write forwarding requires Aurora MySQL version 3.04 or higher.
EnabledCloudwatchLogsExports []string: Set of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, error, general, slowquery, postgresql (PostgreSQL).
EngineLifecycleSupport string: The life cycle type for this DB instance. This setting is valid for cluster types Aurora DB clusters and Multi-AZ DB clusters. Valid values are open-source-rds-extended-support, open-source-rds-extended-support-disabled. Default value is open-source-rds-extended-support. [Using Amazon RDS Extended Support]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html
EngineMode string | EngineMode: Database engine mode. Valid values: global (only valid for Aurora MySQL 1.21 and earlier), parallelquery, provisioned, serverless. Defaults to: provisioned. See the RDS User Guide for limitations when using serverless.
EngineVersion string: Database engine version. Updating this argument results in an outage. See the Aurora MySQL and Aurora Postgres documentation for your configured engine to determine this value, or by running aws rds describe-db-engine-versions. For example with Aurora MySQL 2, a potential value for this argument is 5.7.mysql_aurora.2.03.2. The value can contain a partial version where supported by the API. The actual engine version used is returned in the attribute engine_version_actual, , see Attribute Reference below.
FinalSnapshotIdentifier string: Name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
GlobalClusterIdentifier string: Global cluster identifier specified on aws.rds.GlobalCluster.
IamDatabaseAuthenticationEnabled bool: Specifies whether or not mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Please see AWS Documentation for availability and limitations.
IamRoles []string: List of ARNs for the IAM roles to associate to the RDS Cluster.
Iops int: Amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. For information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide. (This setting is required to create a Multi-AZ DB cluster). Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
KmsKeyId string: ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.
ManageMasterUserPassword bool: Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if master_password is provided.
MasterPassword string: Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the RDS Naming Constraints. Cannot be set if manage_master_user_password is set to true.
MasterUserSecretKmsKeyId string: Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. If not specified, the default KMS key for your Amazon Web Services account is used.
MasterUsername string: Username for the master DB user. Please refer to the RDS Naming Constraints. This argument does not support in-place updates and cannot be changed during a restore from snapshot.
NetworkType string: Network type of the cluster. Valid values: IPV4, DUAL.
PerformanceInsightsEnabled bool: Valid only for Non-Aurora Multi-AZ DB Clusters. Enables Performance Insights for the RDS Cluster
PerformanceInsightsKmsKeyId string: Valid only for Non-Aurora Multi-AZ DB Clusters. Specifies the KMS Key ID to encrypt Performance Insights data. If not specified, the default RDS KMS key will be used (aws/rds).
PerformanceInsightsRetentionPeriod int: Valid only for Non-Aurora Multi-AZ DB Clusters. Specifies the amount of time to retain performance insights data for. Defaults to 7 days if Performance Insights are enabled. Valid values are 7, month * 31 (where month is a number of months from 1-23), and 731. See here for more information on retention periods.
Port int: Port on which the DB accepts connections.
PreferredBackupWindow string: Daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC. Default: A 30-minute window selected at random from an 8-hour block of time per region, e.g. 04:00-09:00.
PreferredMaintenanceWindow string: Weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
ReplicationSourceIdentifier string: ARN of a source DB cluster or DB instance if this DB cluster is to be created as a Read Replica. If DB Cluster is part of a Global Cluster, use the lifecycle configuration block ignore_changes argument to prevent this provider from showing differences for this argument instead of configuring this value.
RestoreToPointInTime ClusterRestoreToPointInTimeArgs: Nested attribute for point in time restore. More details below.
S3Import ClusterS3ImportArgs
ScalingConfiguration ClusterScalingConfigurationArgs: Nested attribute with scaling properties. Only valid when engine_mode is set to serverless. More details below.
Serverlessv2ScalingConfiguration ClusterServerlessv2ScalingConfigurationArgs: Nested attribute with scaling properties for ServerlessV2. Only valid when engine_mode is set to provisioned. More details below.
SkipFinalSnapshot bool: Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from final_snapshot_identifier. Default is false.
SnapshotIdentifier string: Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot. Conflicts with global_cluster_identifier. Clusters cannot be restored from snapshot and joined to an existing global cluster in a single operation. See the AWS documentation or the Global Cluster Restored From Snapshot example for instructions on building a global cluster starting with a snapshot.
SourceRegion string: The source region for an encrypted replica DB cluster.
StorageEncrypted bool: Specifies whether the DB cluster is encrypted. The default is false for provisioned engine_mode and true for serverless engine_mode. When restoring an unencrypted snapshot_identifier, the kms_key_id argument must be provided to encrypt the restored cluster. The provider will only perform drift detection if a configuration value is provided.
StorageType string: (Forces new for Multi-AZ DB clusters) Specifies the storage type to be associated with the DB cluster. For Aurora DB clusters, storage_type modifications can be done in-place. For Multi-AZ DB Clusters, the iops argument must also be set. Valid values are: "", aurora-iopt1 (Aurora DB Clusters); io1, io2 (Multi-AZ DB Clusters). Default: "" (Aurora DB Clusters); io1 (Multi-AZ DB Clusters).
Tags map[string]string: A map of tags to assign to the DB cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
VpcSecurityGroupIds []string: List of VPC security groups to associate with the Cluster

engine String | EngineType: Name of the database engine to be used for this DB cluster. Valid Values: aurora-mysql, aurora-postgresql, mysql, postgres. (Note that mysql and postgres are Multi-AZ RDS clusters).
allocatedStorage Integer: The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
allowMajorVersionUpgrade Boolean: Enable to allow major engine version upgrades when changing engine versions. Defaults to false.
applyImmediately Boolean: Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.
availabilityZones List<String>: List of EC2 Availability Zones for the DB cluster storage where DB cluster instances can be created. RDS automatically assigns 3 AZs if less than 3 AZs are configured, which will show as a difference requiring resource recreation next pulumi up. We recommend specifying 3 AZs or using the lifecycle configuration block ignore_changes argument if necessary. A maximum of 3 AZs can be configured.
backtrackWindow Integer: Target backtrack window, in seconds. Only available for aurora and aurora-mysql engines currently. To disable backtracking, set this value to 0. Defaults to 0. Must be between 0 and 259200 (72 hours)
backupRetentionPeriod Integer: Days to retain backups for. Default 1
caCertificateIdentifier String: The CA certificate identifier to use for the DB cluster's server certificate.
clusterIdentifier String: The cluster identifier. If omitted, this provider will assign a random, unique identifier.
clusterIdentifierPrefix String: Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
clusterMembers List<String>: List of RDS Instances that are a part of this cluster
copyTagsToSnapshot Boolean: Copy all Cluster tags to snapshots. Default is false.
databaseName String: Name for an automatically created database on cluster creation. There are different naming restrictions per database engine: RDS Naming Constraints
dbClusterInstanceClass String: The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide.
dbClusterParameterGroupName String: A cluster parameter group to associate with the cluster.
dbInstanceParameterGroupName String: Instance parameter group to associate with all instances of the DB cluster. The db_instance_parameter_group_name parameter is only valid in combination with the allow_major_version_upgrade parameter.
dbSubnetGroupName String: DB subnet group to associate with this DB cluster. NOTE: This must match the db_subnet_group_name specified on every aws.rds.ClusterInstance in the cluster.
dbSystemId String: For use with RDS Custom.
deleteAutomatedBackups Boolean: Specifies whether to remove automated backups immediately after the DB cluster is deleted. Default is true.
deletionProtection Boolean: If the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.
domain String: The ID of the Directory Service Active Directory domain to create the cluster in.
domainIamRoleName String: The name of the IAM role to be used when making API calls to the Directory Service.
enableGlobalWriteForwarding Boolean: Whether cluster should forward writes to an associated global cluster. Applied to secondary clusters to enable them to forward writes to an aws.rds.GlobalCluster's primary cluster. See the User Guide for Aurora for more information.
enableHttpEndpoint Boolean: Enable HTTP endpoint (data API). Only valid for some combinations of engine_mode, engine and engine_version and only available in some regions. See the Region and version availability section of the documentation. This option also does not work with any of these options specified: snapshot_identifier, replication_source_identifier, s3_import.
enableLocalWriteForwarding Boolean: Whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.. See the User Guide for Aurora for more information. NOTE: Local write forwarding requires Aurora MySQL version 3.04 or higher.
enabledCloudwatchLogsExports List<String>: Set of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, error, general, slowquery, postgresql (PostgreSQL).
engineLifecycleSupport String: The life cycle type for this DB instance. This setting is valid for cluster types Aurora DB clusters and Multi-AZ DB clusters. Valid values are open-source-rds-extended-support, open-source-rds-extended-support-disabled. Default value is open-source-rds-extended-support. [Using Amazon RDS Extended Support]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html
engineMode String | EngineMode: Database engine mode. Valid values: global (only valid for Aurora MySQL 1.21 and earlier), parallelquery, provisioned, serverless. Defaults to: provisioned. See the RDS User Guide for limitations when using serverless.
engineVersion String: Database engine version. Updating this argument results in an outage. See the Aurora MySQL and Aurora Postgres documentation for your configured engine to determine this value, or by running aws rds describe-db-engine-versions. For example with Aurora MySQL 2, a potential value for this argument is 5.7.mysql_aurora.2.03.2. The value can contain a partial version where supported by the API. The actual engine version used is returned in the attribute engine_version_actual, , see Attribute Reference below.
finalSnapshotIdentifier String: Name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
globalClusterIdentifier String: Global cluster identifier specified on aws.rds.GlobalCluster.
iamDatabaseAuthenticationEnabled Boolean: Specifies whether or not mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Please see AWS Documentation for availability and limitations.
iamRoles List<String>: List of ARNs for the IAM roles to associate to the RDS Cluster.
iops Integer: Amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. For information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide. (This setting is required to create a Multi-AZ DB cluster). Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
kmsKeyId String: ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.
manageMasterUserPassword Boolean: Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if master_password is provided.
masterPassword String: Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the RDS Naming Constraints. Cannot be set if manage_master_user_password is set to true.
masterUserSecretKmsKeyId String: Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. If not specified, the default KMS key for your Amazon Web Services account is used.
masterUsername String: Username for the master DB user. Please refer to the RDS Naming Constraints. This argument does not support in-place updates and cannot be changed during a restore from snapshot.
networkType String: Network type of the cluster. Valid values: IPV4, DUAL.
performanceInsightsEnabled Boolean: Valid only for Non-Aurora Multi-AZ DB Clusters. Enables Performance Insights for the RDS Cluster
performanceInsightsKmsKeyId String: Valid only for Non-Aurora Multi-AZ DB Clusters. Specifies the KMS Key ID to encrypt Performance Insights data. If not specified, the default RDS KMS key will be used (aws/rds).
performanceInsightsRetentionPeriod Integer: Valid only for Non-Aurora Multi-AZ DB Clusters. Specifies the amount of time to retain performance insights data for. Defaults to 7 days if Performance Insights are enabled. Valid values are 7, month * 31 (where month is a number of months from 1-23), and 731. See here for more information on retention periods.
port Integer: Port on which the DB accepts connections.
preferredBackupWindow String: Daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC. Default: A 30-minute window selected at random from an 8-hour block of time per region, e.g. 04:00-09:00.
preferredMaintenanceWindow String: Weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
replicationSourceIdentifier String: ARN of a source DB cluster or DB instance if this DB cluster is to be created as a Read Replica. If DB Cluster is part of a Global Cluster, use the lifecycle configuration block ignore_changes argument to prevent this provider from showing differences for this argument instead of configuring this value.
restoreToPointInTime ClusterRestoreToPointInTime: Nested attribute for point in time restore. More details below.
s3Import ClusterS3Import
scalingConfiguration ClusterScalingConfiguration: Nested attribute with scaling properties. Only valid when engine_mode is set to serverless. More details below.
serverlessv2ScalingConfiguration ClusterServerlessv2ScalingConfiguration: Nested attribute with scaling properties for ServerlessV2. Only valid when engine_mode is set to provisioned. More details below.
skipFinalSnapshot Boolean: Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from final_snapshot_identifier. Default is false.
snapshotIdentifier String: Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot. Conflicts with global_cluster_identifier. Clusters cannot be restored from snapshot and joined to an existing global cluster in a single operation. See the AWS documentation or the Global Cluster Restored From Snapshot example for instructions on building a global cluster starting with a snapshot.
sourceRegion String: The source region for an encrypted replica DB cluster.
storageEncrypted Boolean: Specifies whether the DB cluster is encrypted. The default is false for provisioned engine_mode and true for serverless engine_mode. When restoring an unencrypted snapshot_identifier, the kms_key_id argument must be provided to encrypt the restored cluster. The provider will only perform drift detection if a configuration value is provided.
storageType String: (Forces new for Multi-AZ DB clusters) Specifies the storage type to be associated with the DB cluster. For Aurora DB clusters, storage_type modifications can be done in-place. For Multi-AZ DB Clusters, the iops argument must also be set. Valid values are: "", aurora-iopt1 (Aurora DB Clusters); io1, io2 (Multi-AZ DB Clusters). Default: "" (Aurora DB Clusters); io1 (Multi-AZ DB Clusters).
tags Map<String,String>: A map of tags to assign to the DB cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
vpcSecurityGroupIds List<String>: List of VPC security groups to associate with the Cluster

engine string | EngineType: Name of the database engine to be used for this DB cluster. Valid Values: aurora-mysql, aurora-postgresql, mysql, postgres. (Note that mysql and postgres are Multi-AZ RDS clusters).
allocatedStorage number: The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
allowMajorVersionUpgrade boolean: Enable to allow major engine version upgrades when changing engine versions. Defaults to false.
applyImmediately boolean: Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.
availabilityZones string[]: List of EC2 Availability Zones for the DB cluster storage where DB cluster instances can be created. RDS automatically assigns 3 AZs if less than 3 AZs are configured, which will show as a difference requiring resource recreation next pulumi up. We recommend specifying 3 AZs or using the lifecycle configuration block ignore_changes argument if necessary. A maximum of 3 AZs can be configured.
backtrackWindow number: Target backtrack window, in seconds. Only available for aurora and aurora-mysql engines currently. To disable backtracking, set this value to 0. Defaults to 0. Must be between 0 and 259200 (72 hours)
backupRetentionPeriod number: Days to retain backups for. Default 1
caCertificateIdentifier string: The CA certificate identifier to use for the DB cluster's server certificate.
clusterIdentifier string: The cluster identifier. If omitted, this provider will assign a random, unique identifier.
clusterIdentifierPrefix string: Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
clusterMembers string[]: List of RDS Instances that are a part of this cluster
copyTagsToSnapshot boolean: Copy all Cluster tags to snapshots. Default is false.
databaseName string: Name for an automatically created database on cluster creation. There are different naming restrictions per database engine: RDS Naming Constraints
dbClusterInstanceClass string: The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide.
dbClusterParameterGroupName string: A cluster parameter group to associate with the cluster.
dbInstanceParameterGroupName string: Instance parameter group to associate with all instances of the DB cluster. The db_instance_parameter_group_name parameter is only valid in combination with the allow_major_version_upgrade parameter.
dbSubnetGroupName string: DB subnet group to associate with this DB cluster. NOTE: This must match the db_subnet_group_name specified on every aws.rds.ClusterInstance in the cluster.
dbSystemId string: For use with RDS Custom.
deleteAutomatedBackups boolean: Specifies whether to remove automated backups immediately after the DB cluster is deleted. Default is true.
deletionProtection boolean: If the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.
domain string: The ID of the Directory Service Active Directory domain to create the cluster in.
domainIamRoleName string: The name of the IAM role to be used when making API calls to the Directory Service.
enableGlobalWriteForwarding boolean: Whether cluster should forward writes to an associated global cluster. Applied to secondary clusters to enable them to forward writes to an aws.rds.GlobalCluster's primary cluster. See the User Guide for Aurora for more information.
enableHttpEndpoint boolean: Enable HTTP endpoint (data API). Only valid for some combinations of engine_mode, engine and engine_version and only available in some regions. See the Region and version availability section of the documentation. This option also does not work with any of these options specified: snapshot_identifier, replication_source_identifier, s3_import.
enableLocalWriteForwarding boolean: Whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.. See the User Guide for Aurora for more information. NOTE: Local write forwarding requires Aurora MySQL version 3.04 or higher.
enabledCloudwatchLogsExports string[]: Set of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, error, general, slowquery, postgresql (PostgreSQL).
engineLifecycleSupport string: The life cycle type for this DB instance. This setting is valid for cluster types Aurora DB clusters and Multi-AZ DB clusters. Valid values are open-source-rds-extended-support, open-source-rds-extended-support-disabled. Default value is open-source-rds-extended-support. [Using Amazon RDS Extended Support]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html
engineMode string | EngineMode: Database engine mode. Valid values: global (only valid for Aurora MySQL 1.21 and earlier), parallelquery, provisioned, serverless. Defaults to: provisioned. See the RDS User Guide for limitations when using serverless.
engineVersion string: Database engine version. Updating this argument results in an outage. See the Aurora MySQL and Aurora Postgres documentation for your configured engine to determine this value, or by running aws rds describe-db-engine-versions. For example with Aurora MySQL 2, a potential value for this argument is 5.7.mysql_aurora.2.03.2. The value can contain a partial version where supported by the API. The actual engine version used is returned in the attribute engine_version_actual, , see Attribute Reference below.
finalSnapshotIdentifier string: Name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
globalClusterIdentifier string: Global cluster identifier specified on aws.rds.GlobalCluster.
iamDatabaseAuthenticationEnabled boolean: Specifies whether or not mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Please see AWS Documentation for availability and limitations.
iamRoles string[]: List of ARNs for the IAM roles to associate to the RDS Cluster.
iops number: Amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. For information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide. (This setting is required to create a Multi-AZ DB cluster). Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
kmsKeyId string: ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.
manageMasterUserPassword boolean: Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if master_password is provided.
masterPassword string: Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the RDS Naming Constraints. Cannot be set if manage_master_user_password is set to true.
masterUserSecretKmsKeyId string: Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. If not specified, the default KMS key for your Amazon Web Services account is used.
masterUsername string: Username for the master DB user. Please refer to the RDS Naming Constraints. This argument does not support in-place updates and cannot be changed during a restore from snapshot.
networkType string: Network type of the cluster. Valid values: IPV4, DUAL.
performanceInsightsEnabled boolean: Valid only for Non-Aurora Multi-AZ DB Clusters. Enables Performance Insights for the RDS Cluster
performanceInsightsKmsKeyId string: Valid only for Non-Aurora Multi-AZ DB Clusters. Specifies the KMS Key ID to encrypt Performance Insights data. If not specified, the default RDS KMS key will be used (aws/rds).
performanceInsightsRetentionPeriod number: Valid only for Non-Aurora Multi-AZ DB Clusters. Specifies the amount of time to retain performance insights data for. Defaults to 7 days if Performance Insights are enabled. Valid values are 7, month * 31 (where month is a number of months from 1-23), and 731. See here for more information on retention periods.
port number: Port on which the DB accepts connections.
preferredBackupWindow string: Daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC. Default: A 30-minute window selected at random from an 8-hour block of time per region, e.g. 04:00-09:00.
preferredMaintenanceWindow string: Weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
replicationSourceIdentifier string: ARN of a source DB cluster or DB instance if this DB cluster is to be created as a Read Replica. If DB Cluster is part of a Global Cluster, use the lifecycle configuration block ignore_changes argument to prevent this provider from showing differences for this argument instead of configuring this value.
restoreToPointInTime ClusterRestoreToPointInTime: Nested attribute for point in time restore. More details below.
s3Import ClusterS3Import
scalingConfiguration ClusterScalingConfiguration: Nested attribute with scaling properties. Only valid when engine_mode is set to serverless. More details below.
serverlessv2ScalingConfiguration ClusterServerlessv2ScalingConfiguration: Nested attribute with scaling properties for ServerlessV2. Only valid when engine_mode is set to provisioned. More details below.
skipFinalSnapshot boolean: Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from final_snapshot_identifier. Default is false.
snapshotIdentifier string: Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot. Conflicts with global_cluster_identifier. Clusters cannot be restored from snapshot and joined to an existing global cluster in a single operation. See the AWS documentation or the Global Cluster Restored From Snapshot example for instructions on building a global cluster starting with a snapshot.
sourceRegion string: The source region for an encrypted replica DB cluster.
storageEncrypted boolean: Specifies whether the DB cluster is encrypted. The default is false for provisioned engine_mode and true for serverless engine_mode. When restoring an unencrypted snapshot_identifier, the kms_key_id argument must be provided to encrypt the restored cluster. The provider will only perform drift detection if a configuration value is provided.
storageType string: (Forces new for Multi-AZ DB clusters) Specifies the storage type to be associated with the DB cluster. For Aurora DB clusters, storage_type modifications can be done in-place. For Multi-AZ DB Clusters, the iops argument must also be set. Valid values are: "", aurora-iopt1 (Aurora DB Clusters); io1, io2 (Multi-AZ DB Clusters). Default: "" (Aurora DB Clusters); io1 (Multi-AZ DB Clusters).
tags {[key: string]: string}: A map of tags to assign to the DB cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
vpcSecurityGroupIds string[]: List of VPC security groups to associate with the Cluster

engine str | EngineType: Name of the database engine to be used for this DB cluster. Valid Values: aurora-mysql, aurora-postgresql, mysql, postgres. (Note that mysql and postgres are Multi-AZ RDS clusters).
allocated_storage int: The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
allow_major_version_upgrade bool: Enable to allow major engine version upgrades when changing engine versions. Defaults to false.
apply_immediately bool: Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.
availability_zones Sequence[str]: List of EC2 Availability Zones for the DB cluster storage where DB cluster instances can be created. RDS automatically assigns 3 AZs if less than 3 AZs are configured, which will show as a difference requiring resource recreation next pulumi up. We recommend specifying 3 AZs or using the lifecycle configuration block ignore_changes argument if necessary. A maximum of 3 AZs can be configured.
backtrack_window int: Target backtrack window, in seconds. Only available for aurora and aurora-mysql engines currently. To disable backtracking, set this value to 0. Defaults to 0. Must be between 0 and 259200 (72 hours)
backup_retention_period int: Days to retain backups for. Default 1
ca_certificate_identifier str: The CA certificate identifier to use for the DB cluster's server certificate.
cluster_identifier str: The cluster identifier. If omitted, this provider will assign a random, unique identifier.
cluster_identifier_prefix str: Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
cluster_members Sequence[str]: List of RDS Instances that are a part of this cluster
copy_tags_to_snapshot bool: Copy all Cluster tags to snapshots. Default is false.
database_name str: Name for an automatically created database on cluster creation. There are different naming restrictions per database engine: RDS Naming Constraints
db_cluster_instance_class str: The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide.
db_cluster_parameter_group_name str: A cluster parameter group to associate with the cluster.
db_instance_parameter_group_name str: Instance parameter group to associate with all instances of the DB cluster. The db_instance_parameter_group_name parameter is only valid in combination with the allow_major_version_upgrade parameter.
db_subnet_group_name str: DB subnet group to associate with this DB cluster. NOTE: This must match the db_subnet_group_name specified on every aws.rds.ClusterInstance in the cluster.
db_system_id str: For use with RDS Custom.
delete_automated_backups bool: Specifies whether to remove automated backups immediately after the DB cluster is deleted. Default is true.
deletion_protection bool: If the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.
domain str: The ID of the Directory Service Active Directory domain to create the cluster in.
domain_iam_role_name str: The name of the IAM role to be used when making API calls to the Directory Service.
enable_global_write_forwarding bool: Whether cluster should forward writes to an associated global cluster. Applied to secondary clusters to enable them to forward writes to an aws.rds.GlobalCluster's primary cluster. See the User Guide for Aurora for more information.
enable_http_endpoint bool: Enable HTTP endpoint (data API). Only valid for some combinations of engine_mode, engine and engine_version and only available in some regions. See the Region and version availability section of the documentation. This option also does not work with any of these options specified: snapshot_identifier, replication_source_identifier, s3_import.
enable_local_write_forwarding bool: Whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.. See the User Guide for Aurora for more information. NOTE: Local write forwarding requires Aurora MySQL version 3.04 or higher.
enabled_cloudwatch_logs_exports Sequence[str]: Set of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, error, general, slowquery, postgresql (PostgreSQL).
engine_lifecycle_support str: The life cycle type for this DB instance. This setting is valid for cluster types Aurora DB clusters and Multi-AZ DB clusters. Valid values are open-source-rds-extended-support, open-source-rds-extended-support-disabled. Default value is open-source-rds-extended-support. [Using Amazon RDS Extended Support]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html
engine_mode str | EngineMode: Database engine mode. Valid values: global (only valid for Aurora MySQL 1.21 and earlier), parallelquery, provisioned, serverless. Defaults to: provisioned. See the RDS User Guide for limitations when using serverless.
engine_version str: Database engine version. Updating this argument results in an outage. See the Aurora MySQL and Aurora Postgres documentation for your configured engine to determine this value, or by running aws rds describe-db-engine-versions. For example with Aurora MySQL 2, a potential value for this argument is 5.7.mysql_aurora.2.03.2. The value can contain a partial version where supported by the API. The actual engine version used is returned in the attribute engine_version_actual, , see Attribute Reference below.
final_snapshot_identifier str: Name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
global_cluster_identifier str: Global cluster identifier specified on aws.rds.GlobalCluster.
iam_database_authentication_enabled bool: Specifies whether or not mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Please see AWS Documentation for availability and limitations.
iam_roles Sequence[str]: List of ARNs for the IAM roles to associate to the RDS Cluster.
iops int: Amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. For information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide. (This setting is required to create a Multi-AZ DB cluster). Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
kms_key_id str: ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.
manage_master_user_password bool: Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if master_password is provided.
master_password str: Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the RDS Naming Constraints. Cannot be set if manage_master_user_password is set to true.
master_user_secret_kms_key_id str: Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. If not specified, the default KMS key for your Amazon Web Services account is used.
master_username str: Username for the master DB user. Please refer to the RDS Naming Constraints. This argument does not support in-place updates and cannot be changed during a restore from snapshot.
network_type str: Network type of the cluster. Valid values: IPV4, DUAL.
performance_insights_enabled bool: Valid only for Non-Aurora Multi-AZ DB Clusters. Enables Performance Insights for the RDS Cluster
performance_insights_kms_key_id str: Valid only for Non-Aurora Multi-AZ DB Clusters. Specifies the KMS Key ID to encrypt Performance Insights data. If not specified, the default RDS KMS key will be used (aws/rds).
performance_insights_retention_period int: Valid only for Non-Aurora Multi-AZ DB Clusters. Specifies the amount of time to retain performance insights data for. Defaults to 7 days if Performance Insights are enabled. Valid values are 7, month * 31 (where month is a number of months from 1-23), and 731. See here for more information on retention periods.
port int: Port on which the DB accepts connections.
preferred_backup_window str: Daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC. Default: A 30-minute window selected at random from an 8-hour block of time per region, e.g. 04:00-09:00.
preferred_maintenance_window str: Weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
replication_source_identifier str: ARN of a source DB cluster or DB instance if this DB cluster is to be created as a Read Replica. If DB Cluster is part of a Global Cluster, use the lifecycle configuration block ignore_changes argument to prevent this provider from showing differences for this argument instead of configuring this value.
restore_to_point_in_time ClusterRestoreToPointInTimeArgs: Nested attribute for point in time restore. More details below.
s3_import ClusterS3ImportArgs
scaling_configuration ClusterScalingConfigurationArgs: Nested attribute with scaling properties. Only valid when engine_mode is set to serverless. More details below.
serverlessv2_scaling_configuration ClusterServerlessv2ScalingConfigurationArgs: Nested attribute with scaling properties for ServerlessV2. Only valid when engine_mode is set to provisioned. More details below.
skip_final_snapshot bool: Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from final_snapshot_identifier. Default is false.
snapshot_identifier str: Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot. Conflicts with global_cluster_identifier. Clusters cannot be restored from snapshot and joined to an existing global cluster in a single operation. See the AWS documentation or the Global Cluster Restored From Snapshot example for instructions on building a global cluster starting with a snapshot.
source_region str: The source region for an encrypted replica DB cluster.
storage_encrypted bool: Specifies whether the DB cluster is encrypted. The default is false for provisioned engine_mode and true for serverless engine_mode. When restoring an unencrypted snapshot_identifier, the kms_key_id argument must be provided to encrypt the restored cluster. The provider will only perform drift detection if a configuration value is provided.
storage_type str: (Forces new for Multi-AZ DB clusters) Specifies the storage type to be associated with the DB cluster. For Aurora DB clusters, storage_type modifications can be done in-place. For Multi-AZ DB Clusters, the iops argument must also be set. Valid values are: "", aurora-iopt1 (Aurora DB Clusters); io1, io2 (Multi-AZ DB Clusters). Default: "" (Aurora DB Clusters); io1 (Multi-AZ DB Clusters).
tags Mapping[str, str]: A map of tags to assign to the DB cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
vpc_security_group_ids Sequence[str]: List of VPC security groups to associate with the Cluster

engine String | "aurora" | "aurora-mysql" | "aurora-postgresql": Name of the database engine to be used for this DB cluster. Valid Values: aurora-mysql, aurora-postgresql, mysql, postgres. (Note that mysql and postgres are Multi-AZ RDS clusters).
allocatedStorage Number: The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
allowMajorVersionUpgrade Boolean: Enable to allow major engine version upgrades when changing engine versions. Defaults to false.
applyImmediately Boolean: Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.
availabilityZones List<String>: List of EC2 Availability Zones for the DB cluster storage where DB cluster instances can be created. RDS automatically assigns 3 AZs if less than 3 AZs are configured, which will show as a difference requiring resource recreation next pulumi up. We recommend specifying 3 AZs or using the lifecycle configuration block ignore_changes argument if necessary. A maximum of 3 AZs can be configured.
backtrackWindow Number: Target backtrack window, in seconds. Only available for aurora and aurora-mysql engines currently. To disable backtracking, set this value to 0. Defaults to 0. Must be between 0 and 259200 (72 hours)
backupRetentionPeriod Number: Days to retain backups for. Default 1
caCertificateIdentifier String: The CA certificate identifier to use for the DB cluster's server certificate.
clusterIdentifier String: The cluster identifier. If omitted, this provider will assign a random, unique identifier.
clusterIdentifierPrefix String: Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
clusterMembers List<String>: List of RDS Instances that are a part of this cluster
copyTagsToSnapshot Boolean: Copy all Cluster tags to snapshots. Default is false.
databaseName String: Name for an automatically created database on cluster creation. There are different naming restrictions per database engine: RDS Naming Constraints
dbClusterInstanceClass String: The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide.
dbClusterParameterGroupName String: A cluster parameter group to associate with the cluster.
dbInstanceParameterGroupName String: Instance parameter group to associate with all instances of the DB cluster. The db_instance_parameter_group_name parameter is only valid in combination with the allow_major_version_upgrade parameter.
dbSubnetGroupName String: DB subnet group to associate with this DB cluster. NOTE: This must match the db_subnet_group_name specified on every aws.rds.ClusterInstance in the cluster.
dbSystemId String: For use with RDS Custom.
deleteAutomatedBackups Boolean: Specifies whether to remove automated backups immediately after the DB cluster is deleted. Default is true.
deletionProtection Boolean: If the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.
domain String: The ID of the Directory Service Active Directory domain to create the cluster in.
domainIamRoleName String: The name of the IAM role to be used when making API calls to the Directory Service.
enableGlobalWriteForwarding Boolean: Whether cluster should forward writes to an associated global cluster. Applied to secondary clusters to enable them to forward writes to an aws.rds.GlobalCluster's primary cluster. See the User Guide for Aurora for more information.
enableHttpEndpoint Boolean: Enable HTTP endpoint (data API). Only valid for some combinations of engine_mode, engine and engine_version and only available in some regions. See the Region and version availability section of the documentation. This option also does not work with any of these options specified: snapshot_identifier, replication_source_identifier, s3_import.
enableLocalWriteForwarding Boolean: Whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.. See the User Guide for Aurora for more information. NOTE: Local write forwarding requires Aurora MySQL version 3.04 or higher.
enabledCloudwatchLogsExports List<String>: Set of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, error, general, slowquery, postgresql (PostgreSQL).
engineLifecycleSupport String: The life cycle type for this DB instance. This setting is valid for cluster types Aurora DB clusters and Multi-AZ DB clusters. Valid values are open-source-rds-extended-support, open-source-rds-extended-support-disabled. Default value is open-source-rds-extended-support. [Using Amazon RDS Extended Support]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html
engineMode String | "provisioned" | "serverless" | "parallelquery" | "global": Database engine mode. Valid values: global (only valid for Aurora MySQL 1.21 and earlier), parallelquery, provisioned, serverless. Defaults to: provisioned. See the RDS User Guide for limitations when using serverless.
engineVersion String: Database engine version. Updating this argument results in an outage. See the Aurora MySQL and Aurora Postgres documentation for your configured engine to determine this value, or by running aws rds describe-db-engine-versions. For example with Aurora MySQL 2, a potential value for this argument is 5.7.mysql_aurora.2.03.2. The value can contain a partial version where supported by the API. The actual engine version used is returned in the attribute engine_version_actual, , see Attribute Reference below.
finalSnapshotIdentifier String: Name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
globalClusterIdentifier String: Global cluster identifier specified on aws.rds.GlobalCluster.
iamDatabaseAuthenticationEnabled Boolean: Specifies whether or not mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Please see AWS Documentation for availability and limitations.
iamRoles List<String>: List of ARNs for the IAM roles to associate to the RDS Cluster.
iops Number: Amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. For information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide. (This setting is required to create a Multi-AZ DB cluster). Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
kmsKeyId String: ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.
manageMasterUserPassword Boolean: Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if master_password is provided.
masterPassword String: Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the RDS Naming Constraints. Cannot be set if manage_master_user_password is set to true.
masterUserSecretKmsKeyId String: Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. If not specified, the default KMS key for your Amazon Web Services account is used.
masterUsername String: Username for the master DB user. Please refer to the RDS Naming Constraints. This argument does not support in-place updates and cannot be changed during a restore from snapshot.
networkType String: Network type of the cluster. Valid values: IPV4, DUAL.
performanceInsightsEnabled Boolean: Valid only for Non-Aurora Multi-AZ DB Clusters. Enables Performance Insights for the RDS Cluster
performanceInsightsKmsKeyId String: Valid only for Non-Aurora Multi-AZ DB Clusters. Specifies the KMS Key ID to encrypt Performance Insights data. If not specified, the default RDS KMS key will be used (aws/rds).
performanceInsightsRetentionPeriod Number: Valid only for Non-Aurora Multi-AZ DB Clusters. Specifies the amount of time to retain performance insights data for. Defaults to 7 days if Performance Insights are enabled. Valid values are 7, month * 31 (where month is a number of months from 1-23), and 731. See here for more information on retention periods.
port Number: Port on which the DB accepts connections.
preferredBackupWindow String: Daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC. Default: A 30-minute window selected at random from an 8-hour block of time per region, e.g. 04:00-09:00.
preferredMaintenanceWindow String: Weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
replicationSourceIdentifier String: ARN of a source DB cluster or DB instance if this DB cluster is to be created as a Read Replica. If DB Cluster is part of a Global Cluster, use the lifecycle configuration block ignore_changes argument to prevent this provider from showing differences for this argument instead of configuring this value.
restoreToPointInTime Property Map: Nested attribute for point in time restore. More details below.
s3Import Property Map
scalingConfiguration Property Map: Nested attribute with scaling properties. Only valid when engine_mode is set to serverless. More details below.
serverlessv2ScalingConfiguration Property Map: Nested attribute with scaling properties for ServerlessV2. Only valid when engine_mode is set to provisioned. More details below.
skipFinalSnapshot Boolean: Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from final_snapshot_identifier. Default is false.
snapshotIdentifier String: Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot. Conflicts with global_cluster_identifier. Clusters cannot be restored from snapshot and joined to an existing global cluster in a single operation. See the AWS documentation or the Global Cluster Restored From Snapshot example for instructions on building a global cluster starting with a snapshot.
sourceRegion String: The source region for an encrypted replica DB cluster.
storageEncrypted Boolean: Specifies whether the DB cluster is encrypted. The default is false for provisioned engine_mode and true for serverless engine_mode. When restoring an unencrypted snapshot_identifier, the kms_key_id argument must be provided to encrypt the restored cluster. The provider will only perform drift detection if a configuration value is provided.
storageType String: (Forces new for Multi-AZ DB clusters) Specifies the storage type to be associated with the DB cluster. For Aurora DB clusters, storage_type modifications can be done in-place. For Multi-AZ DB Clusters, the iops argument must also be set. Valid values are: "", aurora-iopt1 (Aurora DB Clusters); io1, io2 (Multi-AZ DB Clusters). Default: "" (Aurora DB Clusters); io1 (Multi-AZ DB Clusters).
tags Map<String>: A map of tags to assign to the DB cluster. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
vpcSecurityGroupIds List<String>: List of VPC security groups to associate with the Cluster

Outputs

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

Arn string: Amazon Resource Name (ARN) of cluster
CaCertificateValidTill string: Expiration date of the DB instance’s server certificate
ClusterResourceId string: RDS Cluster Resource ID
Endpoint string: DNS address of the RDS instance
EngineVersionActual string: Running version of the database.
HostedZoneId string: Route53 Hosted Zone ID of the endpoint
Id string: The provider-assigned unique ID for this managed resource.
MasterUserSecrets List<ClusterMasterUserSecret>: Block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.
ReaderEndpoint string: Read-only endpoint for the Aurora cluster, automatically load-balanced across replicas
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.

Arn string: Amazon Resource Name (ARN) of cluster
CaCertificateValidTill string: Expiration date of the DB instance’s server certificate
ClusterResourceId string: RDS Cluster Resource ID
Endpoint string: DNS address of the RDS instance
EngineVersionActual string: Running version of the database.
HostedZoneId string: Route53 Hosted Zone ID of the endpoint
Id string: The provider-assigned unique ID for this managed resource.
MasterUserSecrets []ClusterMasterUserSecret: Block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.
ReaderEndpoint string: Read-only endpoint for the Aurora cluster, automatically load-balanced across replicas
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.

arn String: Amazon Resource Name (ARN) of cluster
caCertificateValidTill String: Expiration date of the DB instance’s server certificate
clusterResourceId String: RDS Cluster Resource ID
endpoint String: DNS address of the RDS instance
engineVersionActual String: Running version of the database.
hostedZoneId String: Route53 Hosted Zone ID of the endpoint
id String: The provider-assigned unique ID for this managed resource.
masterUserSecrets List<ClusterMasterUserSecret>: Block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.
readerEndpoint String: Read-only endpoint for the Aurora cluster, automatically load-balanced across replicas
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.

arn string: Amazon Resource Name (ARN) of cluster
caCertificateValidTill string: Expiration date of the DB instance’s server certificate
clusterResourceId string: RDS Cluster Resource ID
endpoint string: DNS address of the RDS instance
engineVersionActual string: Running version of the database.
hostedZoneId string: Route53 Hosted Zone ID of the endpoint
id string: The provider-assigned unique ID for this managed resource.
masterUserSecrets ClusterMasterUserSecret[]: Block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.
readerEndpoint string: Read-only endpoint for the Aurora cluster, automatically load-balanced across replicas
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.

arn str: Amazon Resource Name (ARN) of cluster
ca_certificate_valid_till str: Expiration date of the DB instance’s server certificate
cluster_resource_id str: RDS Cluster Resource ID
endpoint str: DNS address of the RDS instance
engine_version_actual str: Running version of the database.
hosted_zone_id str: Route53 Hosted Zone ID of the endpoint
id str: The provider-assigned unique ID for this managed resource.
master_user_secrets Sequence[ClusterMasterUserSecret]: Block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.
reader_endpoint str: Read-only endpoint for the Aurora cluster, automatically load-balanced across replicas
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.

arn String: Amazon Resource Name (ARN) of cluster
caCertificateValidTill String: Expiration date of the DB instance’s server certificate
clusterResourceId String: RDS Cluster Resource ID
endpoint String: DNS address of the RDS instance
engineVersionActual String: Running version of the database.
hostedZoneId String: Route53 Hosted Zone ID of the endpoint
id String: The provider-assigned unique ID for this managed resource.
masterUserSecrets List<Property Map>: Block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.
readerEndpoint String: Read-only endpoint for the Aurora cluster, automatically load-balanced across replicas
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.

Look up Existing Cluster Resource

Get an existing Cluster 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?: ClusterState, opts?: CustomResourceOptions): Cluster

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allocated_storage: Optional[int] = None,
        allow_major_version_upgrade: Optional[bool] = None,
        apply_immediately: Optional[bool] = None,
        arn: Optional[str] = None,
        availability_zones: Optional[Sequence[str]] = None,
        backtrack_window: Optional[int] = None,
        backup_retention_period: Optional[int] = None,
        ca_certificate_identifier: Optional[str] = None,
        ca_certificate_valid_till: Optional[str] = None,
        cluster_identifier: Optional[str] = None,
        cluster_identifier_prefix: Optional[str] = None,
        cluster_members: Optional[Sequence[str]] = None,
        cluster_resource_id: Optional[str] = None,
        copy_tags_to_snapshot: Optional[bool] = None,
        database_name: Optional[str] = None,
        db_cluster_instance_class: Optional[str] = None,
        db_cluster_parameter_group_name: Optional[str] = None,
        db_instance_parameter_group_name: Optional[str] = None,
        db_subnet_group_name: Optional[str] = None,
        db_system_id: Optional[str] = None,
        delete_automated_backups: Optional[bool] = None,
        deletion_protection: Optional[bool] = None,
        domain: Optional[str] = None,
        domain_iam_role_name: Optional[str] = None,
        enable_global_write_forwarding: Optional[bool] = None,
        enable_http_endpoint: Optional[bool] = None,
        enable_local_write_forwarding: Optional[bool] = None,
        enabled_cloudwatch_logs_exports: Optional[Sequence[str]] = None,
        endpoint: Optional[str] = None,
        engine: Optional[Union[str, EngineType]] = None,
        engine_lifecycle_support: Optional[str] = None,
        engine_mode: Optional[Union[str, EngineMode]] = None,
        engine_version: Optional[str] = None,
        engine_version_actual: Optional[str] = None,
        final_snapshot_identifier: Optional[str] = None,
        global_cluster_identifier: Optional[str] = None,
        hosted_zone_id: Optional[str] = None,
        iam_database_authentication_enabled: Optional[bool] = None,
        iam_roles: Optional[Sequence[str]] = None,
        iops: Optional[int] = None,
        kms_key_id: Optional[str] = None,
        manage_master_user_password: Optional[bool] = None,
        master_password: Optional[str] = None,
        master_user_secret_kms_key_id: Optional[str] = None,
        master_user_secrets: Optional[Sequence[ClusterMasterUserSecretArgs]] = None,
        master_username: 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,
        reader_endpoint: Optional[str] = None,
        replication_source_identifier: Optional[str] = None,
        restore_to_point_in_time: Optional[ClusterRestoreToPointInTimeArgs] = None,
        s3_import: Optional[ClusterS3ImportArgs] = None,
        scaling_configuration: Optional[ClusterScalingConfigurationArgs] = None,
        serverlessv2_scaling_configuration: Optional[ClusterServerlessv2ScalingConfigurationArgs] = None,
        skip_final_snapshot: Optional[bool] = None,
        snapshot_identifier: Optional[str] = None,
        source_region: Optional[str] = None,
        storage_encrypted: Optional[bool] = None,
        storage_type: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        vpc_security_group_ids: Optional[Sequence[str]] = None) -> Cluster

func GetCluster(ctx *Context, name string, id IDInput, state *ClusterState, opts ...ResourceOption) (*Cluster, error)

public static Cluster Get(string name, Input<string> id, ClusterState? state, CustomResourceOptions? opts = null)

public static Cluster get(String name, Output<String> id, ClusterState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AllocatedStorage int: The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
AllowMajorVersionUpgrade bool: Enable to allow major engine version upgrades when changing engine versions. Defaults to false.
ApplyImmediately bool: Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.
Arn string: Amazon Resource Name (ARN) of cluster
AvailabilityZones List<string>: List of EC2 Availability Zones for the DB cluster storage where DB cluster instances can be created. RDS automatically assigns 3 AZs if less than 3 AZs are configured, which will show as a difference requiring resource recreation next pulumi up. We recommend specifying 3 AZs or using the lifecycle configuration block ignore_changes argument if necessary. A maximum of 3 AZs can be configured.
BacktrackWindow int: Target backtrack window, in seconds. Only available for aurora and aurora-mysql engines currently. To disable backtracking, set this value to 0. Defaults to 0. Must be between 0 and 259200 (72 hours)
BackupRetentionPeriod int: Days to retain backups for. Default 1
CaCertificateIdentifier string: The CA certificate identifier to use for the DB cluster's server certificate.
CaCertificateValidTill string: Expiration date of the DB instance’s server certificate
ClusterIdentifier string: The cluster identifier. If omitted, this provider will assign a random, unique identifier.
ClusterIdentifierPrefix string: Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
ClusterMembers List<string>: List of RDS Instances that are a part of this cluster
ClusterResourceId string: RDS Cluster Resource ID
CopyTagsToSnapshot bool: Copy all Cluster tags to snapshots. Default is false.
DatabaseName string: Name for an automatically created database on cluster creation. There are different naming restrictions per database engine: RDS Naming Constraints
DbClusterInstanceClass string: The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide.
DbClusterParameterGroupName string: A cluster parameter group to associate with the cluster.
DbInstanceParameterGroupName string: Instance parameter group to associate with all instances of the DB cluster. The db_instance_parameter_group_name parameter is only valid in combination with the allow_major_version_upgrade parameter.
DbSubnetGroupName string: DB subnet group to associate with this DB cluster. NOTE: This must match the db_subnet_group_name specified on every aws.rds.ClusterInstance in the cluster.
DbSystemId string: For use with RDS Custom.
DeleteAutomatedBackups bool: Specifies whether to remove automated backups immediately after the DB cluster is deleted. Default is true.
DeletionProtection bool: If the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.
Domain string: The ID of the Directory Service Active Directory domain to create the cluster in.
DomainIamRoleName string: The name of the IAM role to be used when making API calls to the Directory Service.
EnableGlobalWriteForwarding bool: Whether cluster should forward writes to an associated global cluster. Applied to secondary clusters to enable them to forward writes to an aws.rds.GlobalCluster's primary cluster. See the User Guide for Aurora for more information.
EnableHttpEndpoint bool: Enable HTTP endpoint (data API). Only valid for some combinations of engine_mode, engine and engine_version and only available in some regions. See the Region and version availability section of the documentation. This option also does not work with any of these options specified: snapshot_identifier, replication_source_identifier, s3_import.
EnableLocalWriteForwarding bool: Whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.. See the User Guide for Aurora for more information. NOTE: Local write forwarding requires Aurora MySQL version 3.04 or higher.
EnabledCloudwatchLogsExports List<string>: Set of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, error, general, slowquery, postgresql (PostgreSQL).
Endpoint string: DNS address of the RDS instance
Engine string | Pulumi.Aws.Rds.EngineType: Name of the database engine to be used for this DB cluster. Valid Values: aurora-mysql, aurora-postgresql, mysql, postgres. (Note that mysql and postgres are Multi-AZ RDS clusters).
EngineLifecycleSupport string: The life cycle type for this DB instance. This setting is valid for cluster types Aurora DB clusters and Multi-AZ DB clusters. Valid values are open-source-rds-extended-support, open-source-rds-extended-support-disabled. Default value is open-source-rds-extended-support. [Using Amazon RDS Extended Support]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html
EngineMode string | Pulumi.Aws.Rds.EngineMode: Database engine mode. Valid values: global (only valid for Aurora MySQL 1.21 and earlier), parallelquery, provisioned, serverless. Defaults to: provisioned. See the RDS User Guide for limitations when using serverless.
EngineVersion string: Database engine version. Updating this argument results in an outage. See the Aurora MySQL and Aurora Postgres documentation for your configured engine to determine this value, or by running aws rds describe-db-engine-versions. For example with Aurora MySQL 2, a potential value for this argument is 5.7.mysql_aurora.2.03.2. The value can contain a partial version where supported by the API. The actual engine version used is returned in the attribute engine_version_actual, , see Attribute Reference below.
EngineVersionActual string: Running version of the database.
FinalSnapshotIdentifier string: Name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
GlobalClusterIdentifier string: Global cluster identifier specified on aws.rds.GlobalCluster.
HostedZoneId string: Route53 Hosted Zone ID of the endpoint
IamDatabaseAuthenticationEnabled bool: Specifies whether or not mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Please see AWS Documentation for availability and limitations.
IamRoles List<string>: List of ARNs for the IAM roles to associate to the RDS Cluster.
Iops int: Amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. For information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide. (This setting is required to create a Multi-AZ DB cluster). Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
KmsKeyId string: ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.
ManageMasterUserPassword bool: Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if master_password is provided.
MasterPassword string: Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the RDS Naming Constraints. Cannot be set if manage_master_user_password is set to true.
MasterUserSecretKmsKeyId string: Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. If not specified, the default KMS key for your Amazon Web Services account is used.
MasterUserSecrets List<ClusterMasterUserSecret>: Block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.
MasterUsername string: Username for the master DB user. Please refer to the RDS Naming Constraints. This argument does not support in-place updates and cannot be changed during a restore from snapshot.
NetworkType string: Network type of the cluster. Valid values: IPV4, DUAL.
PerformanceInsightsEnabled bool: Valid only for Non-Aurora Multi-AZ DB Clusters. Enables Performance Insights for the RDS Cluster
PerformanceInsightsKmsKeyId string: Valid only for Non-Aurora Multi-AZ DB Clusters. Specifies the KMS Key ID to encrypt Performance Insights data. If not specified, the default RDS KMS key will be used (aws/rds).
PerformanceInsightsRetentionPeriod int: Valid only for Non-Aurora Multi-AZ DB Clusters. Specifies the amount of time to retain performance insights data for. Defaults to 7 days if Performance Insights are enabled. Valid values are 7, month * 31 (where month is a number of months from 1-23), and 731. See here for more information on retention periods.
Port int: Port on which the DB accepts connections.
PreferredBackupWindow string: Daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC. Default: A 30-minute window selected at random from an 8-hour block of time per region, e.g. 04:00-09:00.
PreferredMaintenanceWindow string: Weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
ReaderEndpoint string: Read-only endpoint for the Aurora cluster, automatically load-balanced across replicas
ReplicationSourceIdentifier string: ARN of a source DB cluster or DB instance if this DB cluster is to be created as a Read Replica. If DB Cluster is part of a Global Cluster, use the lifecycle configuration block ignore_changes argument to prevent this provider from showing differences for this argument instead of configuring this value.
RestoreToPointInTime ClusterRestoreToPointInTime: Nested attribute for point in time restore. More details below.
S3Import ClusterS3Import
ScalingConfiguration ClusterScalingConfiguration: Nested attribute with scaling properties. Only valid when engine_mode is set to serverless. More details below.
Serverlessv2ScalingConfiguration ClusterServerlessv2ScalingConfiguration: Nested attribute with scaling properties for ServerlessV2. Only valid when engine_mode is set to provisioned. More details below.
SkipFinalSnapshot bool: Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from final_snapshot_identifier. Default is false.
SnapshotIdentifier string: Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot. Conflicts with global_cluster_identifier. Clusters cannot be restored from snapshot and joined to an existing global cluster in a single operation. See the AWS documentation or the Global Cluster Restored From Snapshot example for instructions on building a global cluster starting with a snapshot.
SourceRegion string: The source region for an encrypted replica DB cluster.
StorageEncrypted bool: Specifies whether the DB cluster is encrypted. The default is false for provisioned engine_mode and true for serverless engine_mode. When restoring an unencrypted snapshot_identifier, the kms_key_id argument must be provided to encrypt the restored cluster. The provider will only perform drift detection if a configuration value is provided.
StorageType string: (Forces new for Multi-AZ DB clusters) Specifies the storage type to be associated with the DB cluster. For Aurora DB clusters, storage_type modifications can be done in-place. For Multi-AZ DB Clusters, the iops argument must also be set. Valid values are: "", aurora-iopt1 (Aurora DB Clusters); io1, io2 (Multi-AZ DB Clusters). Default: "" (Aurora DB Clusters); io1 (Multi-AZ DB Clusters).
Tags Dictionary<string, string>: A map of tags to assign to the DB cluster. 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.
VpcSecurityGroupIds List<string>: List of VPC security groups to associate with the Cluster

AllocatedStorage int: The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
AllowMajorVersionUpgrade bool: Enable to allow major engine version upgrades when changing engine versions. Defaults to false.
ApplyImmediately bool: Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.
Arn string: Amazon Resource Name (ARN) of cluster
AvailabilityZones []string: List of EC2 Availability Zones for the DB cluster storage where DB cluster instances can be created. RDS automatically assigns 3 AZs if less than 3 AZs are configured, which will show as a difference requiring resource recreation next pulumi up. We recommend specifying 3 AZs or using the lifecycle configuration block ignore_changes argument if necessary. A maximum of 3 AZs can be configured.
BacktrackWindow int: Target backtrack window, in seconds. Only available for aurora and aurora-mysql engines currently. To disable backtracking, set this value to 0. Defaults to 0. Must be between 0 and 259200 (72 hours)
BackupRetentionPeriod int: Days to retain backups for. Default 1
CaCertificateIdentifier string: The CA certificate identifier to use for the DB cluster's server certificate.
CaCertificateValidTill string: Expiration date of the DB instance’s server certificate
ClusterIdentifier string: The cluster identifier. If omitted, this provider will assign a random, unique identifier.
ClusterIdentifierPrefix string: Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
ClusterMembers []string: List of RDS Instances that are a part of this cluster
ClusterResourceId string: RDS Cluster Resource ID
CopyTagsToSnapshot bool: Copy all Cluster tags to snapshots. Default is false.
DatabaseName string: Name for an automatically created database on cluster creation. There are different naming restrictions per database engine: RDS Naming Constraints
DbClusterInstanceClass string: The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide.
DbClusterParameterGroupName string: A cluster parameter group to associate with the cluster.
DbInstanceParameterGroupName string: Instance parameter group to associate with all instances of the DB cluster. The db_instance_parameter_group_name parameter is only valid in combination with the allow_major_version_upgrade parameter.
DbSubnetGroupName string: DB subnet group to associate with this DB cluster. NOTE: This must match the db_subnet_group_name specified on every aws.rds.ClusterInstance in the cluster.
DbSystemId string: For use with RDS Custom.
DeleteAutomatedBackups bool: Specifies whether to remove automated backups immediately after the DB cluster is deleted. Default is true.
DeletionProtection bool: If the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.
Domain string: The ID of the Directory Service Active Directory domain to create the cluster in.
DomainIamRoleName string: The name of the IAM role to be used when making API calls to the Directory Service.
EnableGlobalWriteForwarding bool: Whether cluster should forward writes to an associated global cluster. Applied to secondary clusters to enable them to forward writes to an aws.rds.GlobalCluster's primary cluster. See the User Guide for Aurora for more information.
EnableHttpEndpoint bool: Enable HTTP endpoint (data API). Only valid for some combinations of engine_mode, engine and engine_version and only available in some regions. See the Region and version availability section of the documentation. This option also does not work with any of these options specified: snapshot_identifier, replication_source_identifier, s3_import.
EnableLocalWriteForwarding bool: Whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.. See the User Guide for Aurora for more information. NOTE: Local write forwarding requires Aurora MySQL version 3.04 or higher.
EnabledCloudwatchLogsExports []string: Set of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, error, general, slowquery, postgresql (PostgreSQL).
Endpoint string: DNS address of the RDS instance
Engine string | EngineType: Name of the database engine to be used for this DB cluster. Valid Values: aurora-mysql, aurora-postgresql, mysql, postgres. (Note that mysql and postgres are Multi-AZ RDS clusters).
EngineLifecycleSupport string: The life cycle type for this DB instance. This setting is valid for cluster types Aurora DB clusters and Multi-AZ DB clusters. Valid values are open-source-rds-extended-support, open-source-rds-extended-support-disabled. Default value is open-source-rds-extended-support. [Using Amazon RDS Extended Support]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html
EngineMode string | EngineMode: Database engine mode. Valid values: global (only valid for Aurora MySQL 1.21 and earlier), parallelquery, provisioned, serverless. Defaults to: provisioned. See the RDS User Guide for limitations when using serverless.
EngineVersion string: Database engine version. Updating this argument results in an outage. See the Aurora MySQL and Aurora Postgres documentation for your configured engine to determine this value, or by running aws rds describe-db-engine-versions. For example with Aurora MySQL 2, a potential value for this argument is 5.7.mysql_aurora.2.03.2. The value can contain a partial version where supported by the API. The actual engine version used is returned in the attribute engine_version_actual, , see Attribute Reference below.
EngineVersionActual string: Running version of the database.
FinalSnapshotIdentifier string: Name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
GlobalClusterIdentifier string: Global cluster identifier specified on aws.rds.GlobalCluster.
HostedZoneId string: Route53 Hosted Zone ID of the endpoint
IamDatabaseAuthenticationEnabled bool: Specifies whether or not mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Please see AWS Documentation for availability and limitations.
IamRoles []string: List of ARNs for the IAM roles to associate to the RDS Cluster.
Iops int: Amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. For information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide. (This setting is required to create a Multi-AZ DB cluster). Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
KmsKeyId string: ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.
ManageMasterUserPassword bool: Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if master_password is provided.
MasterPassword string: Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the RDS Naming Constraints. Cannot be set if manage_master_user_password is set to true.
MasterUserSecretKmsKeyId string: Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. If not specified, the default KMS key for your Amazon Web Services account is used.
MasterUserSecrets []ClusterMasterUserSecretArgs: Block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.
MasterUsername string: Username for the master DB user. Please refer to the RDS Naming Constraints. This argument does not support in-place updates and cannot be changed during a restore from snapshot.
NetworkType string: Network type of the cluster. Valid values: IPV4, DUAL.
PerformanceInsightsEnabled bool: Valid only for Non-Aurora Multi-AZ DB Clusters. Enables Performance Insights for the RDS Cluster
PerformanceInsightsKmsKeyId string: Valid only for Non-Aurora Multi-AZ DB Clusters. Specifies the KMS Key ID to encrypt Performance Insights data. If not specified, the default RDS KMS key will be used (aws/rds).
PerformanceInsightsRetentionPeriod int: Valid only for Non-Aurora Multi-AZ DB Clusters. Specifies the amount of time to retain performance insights data for. Defaults to 7 days if Performance Insights are enabled. Valid values are 7, month * 31 (where month is a number of months from 1-23), and 731. See here for more information on retention periods.
Port int: Port on which the DB accepts connections.
PreferredBackupWindow string: Daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC. Default: A 30-minute window selected at random from an 8-hour block of time per region, e.g. 04:00-09:00.
PreferredMaintenanceWindow string: Weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
ReaderEndpoint string: Read-only endpoint for the Aurora cluster, automatically load-balanced across replicas
ReplicationSourceIdentifier string: ARN of a source DB cluster or DB instance if this DB cluster is to be created as a Read Replica. If DB Cluster is part of a Global Cluster, use the lifecycle configuration block ignore_changes argument to prevent this provider from showing differences for this argument instead of configuring this value.
RestoreToPointInTime ClusterRestoreToPointInTimeArgs: Nested attribute for point in time restore. More details below.
S3Import ClusterS3ImportArgs
ScalingConfiguration ClusterScalingConfigurationArgs: Nested attribute with scaling properties. Only valid when engine_mode is set to serverless. More details below.
Serverlessv2ScalingConfiguration ClusterServerlessv2ScalingConfigurationArgs: Nested attribute with scaling properties for ServerlessV2. Only valid when engine_mode is set to provisioned. More details below.
SkipFinalSnapshot bool: Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from final_snapshot_identifier. Default is false.
SnapshotIdentifier string: Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot. Conflicts with global_cluster_identifier. Clusters cannot be restored from snapshot and joined to an existing global cluster in a single operation. See the AWS documentation or the Global Cluster Restored From Snapshot example for instructions on building a global cluster starting with a snapshot.
SourceRegion string: The source region for an encrypted replica DB cluster.
StorageEncrypted bool: Specifies whether the DB cluster is encrypted. The default is false for provisioned engine_mode and true for serverless engine_mode. When restoring an unencrypted snapshot_identifier, the kms_key_id argument must be provided to encrypt the restored cluster. The provider will only perform drift detection if a configuration value is provided.
StorageType string: (Forces new for Multi-AZ DB clusters) Specifies the storage type to be associated with the DB cluster. For Aurora DB clusters, storage_type modifications can be done in-place. For Multi-AZ DB Clusters, the iops argument must also be set. Valid values are: "", aurora-iopt1 (Aurora DB Clusters); io1, io2 (Multi-AZ DB Clusters). Default: "" (Aurora DB Clusters); io1 (Multi-AZ DB Clusters).
Tags map[string]string: A map of tags to assign to the DB cluster. 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.
VpcSecurityGroupIds []string: List of VPC security groups to associate with the Cluster

allocatedStorage Integer: The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
allowMajorVersionUpgrade Boolean: Enable to allow major engine version upgrades when changing engine versions. Defaults to false.
applyImmediately Boolean: Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.
arn String: Amazon Resource Name (ARN) of cluster
availabilityZones List<String>: List of EC2 Availability Zones for the DB cluster storage where DB cluster instances can be created. RDS automatically assigns 3 AZs if less than 3 AZs are configured, which will show as a difference requiring resource recreation next pulumi up. We recommend specifying 3 AZs or using the lifecycle configuration block ignore_changes argument if necessary. A maximum of 3 AZs can be configured.
backtrackWindow Integer: Target backtrack window, in seconds. Only available for aurora and aurora-mysql engines currently. To disable backtracking, set this value to 0. Defaults to 0. Must be between 0 and 259200 (72 hours)
backupRetentionPeriod Integer: Days to retain backups for. Default 1
caCertificateIdentifier String: The CA certificate identifier to use for the DB cluster's server certificate.
caCertificateValidTill String: Expiration date of the DB instance’s server certificate
clusterIdentifier String: The cluster identifier. If omitted, this provider will assign a random, unique identifier.
clusterIdentifierPrefix String: Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
clusterMembers List<String>: List of RDS Instances that are a part of this cluster
clusterResourceId String: RDS Cluster Resource ID
copyTagsToSnapshot Boolean: Copy all Cluster tags to snapshots. Default is false.
databaseName String: Name for an automatically created database on cluster creation. There are different naming restrictions per database engine: RDS Naming Constraints
dbClusterInstanceClass String: The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide.
dbClusterParameterGroupName String: A cluster parameter group to associate with the cluster.
dbInstanceParameterGroupName String: Instance parameter group to associate with all instances of the DB cluster. The db_instance_parameter_group_name parameter is only valid in combination with the allow_major_version_upgrade parameter.
dbSubnetGroupName String: DB subnet group to associate with this DB cluster. NOTE: This must match the db_subnet_group_name specified on every aws.rds.ClusterInstance in the cluster.
dbSystemId String: For use with RDS Custom.
deleteAutomatedBackups Boolean: Specifies whether to remove automated backups immediately after the DB cluster is deleted. Default is true.
deletionProtection Boolean: If the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.
domain String: The ID of the Directory Service Active Directory domain to create the cluster in.
domainIamRoleName String: The name of the IAM role to be used when making API calls to the Directory Service.
enableGlobalWriteForwarding Boolean: Whether cluster should forward writes to an associated global cluster. Applied to secondary clusters to enable them to forward writes to an aws.rds.GlobalCluster's primary cluster. See the User Guide for Aurora for more information.
enableHttpEndpoint Boolean: Enable HTTP endpoint (data API). Only valid for some combinations of engine_mode, engine and engine_version and only available in some regions. See the Region and version availability section of the documentation. This option also does not work with any of these options specified: snapshot_identifier, replication_source_identifier, s3_import.
enableLocalWriteForwarding Boolean: Whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.. See the User Guide for Aurora for more information. NOTE: Local write forwarding requires Aurora MySQL version 3.04 or higher.
enabledCloudwatchLogsExports List<String>: Set of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, error, general, slowquery, postgresql (PostgreSQL).
endpoint String: DNS address of the RDS instance
engine String | EngineType: Name of the database engine to be used for this DB cluster. Valid Values: aurora-mysql, aurora-postgresql, mysql, postgres. (Note that mysql and postgres are Multi-AZ RDS clusters).
engineLifecycleSupport String: The life cycle type for this DB instance. This setting is valid for cluster types Aurora DB clusters and Multi-AZ DB clusters. Valid values are open-source-rds-extended-support, open-source-rds-extended-support-disabled. Default value is open-source-rds-extended-support. [Using Amazon RDS Extended Support]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html
engineMode String | EngineMode: Database engine mode. Valid values: global (only valid for Aurora MySQL 1.21 and earlier), parallelquery, provisioned, serverless. Defaults to: provisioned. See the RDS User Guide for limitations when using serverless.
engineVersion String: Database engine version. Updating this argument results in an outage. See the Aurora MySQL and Aurora Postgres documentation for your configured engine to determine this value, or by running aws rds describe-db-engine-versions. For example with Aurora MySQL 2, a potential value for this argument is 5.7.mysql_aurora.2.03.2. The value can contain a partial version where supported by the API. The actual engine version used is returned in the attribute engine_version_actual, , see Attribute Reference below.
engineVersionActual String: Running version of the database.
finalSnapshotIdentifier String: Name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
globalClusterIdentifier String: Global cluster identifier specified on aws.rds.GlobalCluster.
hostedZoneId String: Route53 Hosted Zone ID of the endpoint
iamDatabaseAuthenticationEnabled Boolean: Specifies whether or not mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Please see AWS Documentation for availability and limitations.
iamRoles List<String>: List of ARNs for the IAM roles to associate to the RDS Cluster.
iops Integer: Amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. For information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide. (This setting is required to create a Multi-AZ DB cluster). Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
kmsKeyId String: ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.
manageMasterUserPassword Boolean: Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if master_password is provided.
masterPassword String: Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the RDS Naming Constraints. Cannot be set if manage_master_user_password is set to true.
masterUserSecretKmsKeyId String: Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. If not specified, the default KMS key for your Amazon Web Services account is used.
masterUserSecrets List<ClusterMasterUserSecret>: Block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.
masterUsername String: Username for the master DB user. Please refer to the RDS Naming Constraints. This argument does not support in-place updates and cannot be changed during a restore from snapshot.
networkType String: Network type of the cluster. Valid values: IPV4, DUAL.
performanceInsightsEnabled Boolean: Valid only for Non-Aurora Multi-AZ DB Clusters. Enables Performance Insights for the RDS Cluster
performanceInsightsKmsKeyId String: Valid only for Non-Aurora Multi-AZ DB Clusters. Specifies the KMS Key ID to encrypt Performance Insights data. If not specified, the default RDS KMS key will be used (aws/rds).
performanceInsightsRetentionPeriod Integer: Valid only for Non-Aurora Multi-AZ DB Clusters. Specifies the amount of time to retain performance insights data for. Defaults to 7 days if Performance Insights are enabled. Valid values are 7, month * 31 (where month is a number of months from 1-23), and 731. See here for more information on retention periods.
port Integer: Port on which the DB accepts connections.
preferredBackupWindow String: Daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC. Default: A 30-minute window selected at random from an 8-hour block of time per region, e.g. 04:00-09:00.
preferredMaintenanceWindow String: Weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
readerEndpoint String: Read-only endpoint for the Aurora cluster, automatically load-balanced across replicas
replicationSourceIdentifier String: ARN of a source DB cluster or DB instance if this DB cluster is to be created as a Read Replica. If DB Cluster is part of a Global Cluster, use the lifecycle configuration block ignore_changes argument to prevent this provider from showing differences for this argument instead of configuring this value.
restoreToPointInTime ClusterRestoreToPointInTime: Nested attribute for point in time restore. More details below.
s3Import ClusterS3Import
scalingConfiguration ClusterScalingConfiguration: Nested attribute with scaling properties. Only valid when engine_mode is set to serverless. More details below.
serverlessv2ScalingConfiguration ClusterServerlessv2ScalingConfiguration: Nested attribute with scaling properties for ServerlessV2. Only valid when engine_mode is set to provisioned. More details below.
skipFinalSnapshot Boolean: Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from final_snapshot_identifier. Default is false.
snapshotIdentifier String: Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot. Conflicts with global_cluster_identifier. Clusters cannot be restored from snapshot and joined to an existing global cluster in a single operation. See the AWS documentation or the Global Cluster Restored From Snapshot example for instructions on building a global cluster starting with a snapshot.
sourceRegion String: The source region for an encrypted replica DB cluster.
storageEncrypted Boolean: Specifies whether the DB cluster is encrypted. The default is false for provisioned engine_mode and true for serverless engine_mode. When restoring an unencrypted snapshot_identifier, the kms_key_id argument must be provided to encrypt the restored cluster. The provider will only perform drift detection if a configuration value is provided.
storageType String: (Forces new for Multi-AZ DB clusters) Specifies the storage type to be associated with the DB cluster. For Aurora DB clusters, storage_type modifications can be done in-place. For Multi-AZ DB Clusters, the iops argument must also be set. Valid values are: "", aurora-iopt1 (Aurora DB Clusters); io1, io2 (Multi-AZ DB Clusters). Default: "" (Aurora DB Clusters); io1 (Multi-AZ DB Clusters).
tags Map<String,String>: A map of tags to assign to the DB cluster. 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.
vpcSecurityGroupIds List<String>: List of VPC security groups to associate with the Cluster

allocatedStorage number: The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
allowMajorVersionUpgrade boolean: Enable to allow major engine version upgrades when changing engine versions. Defaults to false.
applyImmediately boolean: Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.
arn string: Amazon Resource Name (ARN) of cluster
availabilityZones string[]: List of EC2 Availability Zones for the DB cluster storage where DB cluster instances can be created. RDS automatically assigns 3 AZs if less than 3 AZs are configured, which will show as a difference requiring resource recreation next pulumi up. We recommend specifying 3 AZs or using the lifecycle configuration block ignore_changes argument if necessary. A maximum of 3 AZs can be configured.
backtrackWindow number: Target backtrack window, in seconds. Only available for aurora and aurora-mysql engines currently. To disable backtracking, set this value to 0. Defaults to 0. Must be between 0 and 259200 (72 hours)
backupRetentionPeriod number: Days to retain backups for. Default 1
caCertificateIdentifier string: The CA certificate identifier to use for the DB cluster's server certificate.
caCertificateValidTill string: Expiration date of the DB instance’s server certificate
clusterIdentifier string: The cluster identifier. If omitted, this provider will assign a random, unique identifier.
clusterIdentifierPrefix string: Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
clusterMembers string[]: List of RDS Instances that are a part of this cluster
clusterResourceId string: RDS Cluster Resource ID
copyTagsToSnapshot boolean: Copy all Cluster tags to snapshots. Default is false.
databaseName string: Name for an automatically created database on cluster creation. There are different naming restrictions per database engine: RDS Naming Constraints
dbClusterInstanceClass string: The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide.
dbClusterParameterGroupName string: A cluster parameter group to associate with the cluster.
dbInstanceParameterGroupName string: Instance parameter group to associate with all instances of the DB cluster. The db_instance_parameter_group_name parameter is only valid in combination with the allow_major_version_upgrade parameter.
dbSubnetGroupName string: DB subnet group to associate with this DB cluster. NOTE: This must match the db_subnet_group_name specified on every aws.rds.ClusterInstance in the cluster.
dbSystemId string: For use with RDS Custom.
deleteAutomatedBackups boolean: Specifies whether to remove automated backups immediately after the DB cluster is deleted. Default is true.
deletionProtection boolean: If the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.
domain string: The ID of the Directory Service Active Directory domain to create the cluster in.
domainIamRoleName string: The name of the IAM role to be used when making API calls to the Directory Service.
enableGlobalWriteForwarding boolean: Whether cluster should forward writes to an associated global cluster. Applied to secondary clusters to enable them to forward writes to an aws.rds.GlobalCluster's primary cluster. See the User Guide for Aurora for more information.
enableHttpEndpoint boolean: Enable HTTP endpoint (data API). Only valid for some combinations of engine_mode, engine and engine_version and only available in some regions. See the Region and version availability section of the documentation. This option also does not work with any of these options specified: snapshot_identifier, replication_source_identifier, s3_import.
enableLocalWriteForwarding boolean: Whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.. See the User Guide for Aurora for more information. NOTE: Local write forwarding requires Aurora MySQL version 3.04 or higher.
enabledCloudwatchLogsExports string[]: Set of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, error, general, slowquery, postgresql (PostgreSQL).
endpoint string: DNS address of the RDS instance
engine string | EngineType: Name of the database engine to be used for this DB cluster. Valid Values: aurora-mysql, aurora-postgresql, mysql, postgres. (Note that mysql and postgres are Multi-AZ RDS clusters).
engineLifecycleSupport string: The life cycle type for this DB instance. This setting is valid for cluster types Aurora DB clusters and Multi-AZ DB clusters. Valid values are open-source-rds-extended-support, open-source-rds-extended-support-disabled. Default value is open-source-rds-extended-support. [Using Amazon RDS Extended Support]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html
engineMode string | EngineMode: Database engine mode. Valid values: global (only valid for Aurora MySQL 1.21 and earlier), parallelquery, provisioned, serverless. Defaults to: provisioned. See the RDS User Guide for limitations when using serverless.
engineVersion string: Database engine version. Updating this argument results in an outage. See the Aurora MySQL and Aurora Postgres documentation for your configured engine to determine this value, or by running aws rds describe-db-engine-versions. For example with Aurora MySQL 2, a potential value for this argument is 5.7.mysql_aurora.2.03.2. The value can contain a partial version where supported by the API. The actual engine version used is returned in the attribute engine_version_actual, , see Attribute Reference below.
engineVersionActual string: Running version of the database.
finalSnapshotIdentifier string: Name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
globalClusterIdentifier string: Global cluster identifier specified on aws.rds.GlobalCluster.
hostedZoneId string: Route53 Hosted Zone ID of the endpoint
iamDatabaseAuthenticationEnabled boolean: Specifies whether or not mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Please see AWS Documentation for availability and limitations.
iamRoles string[]: List of ARNs for the IAM roles to associate to the RDS Cluster.
iops number: Amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. For information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide. (This setting is required to create a Multi-AZ DB cluster). Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
kmsKeyId string: ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.
manageMasterUserPassword boolean: Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if master_password is provided.
masterPassword string: Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the RDS Naming Constraints. Cannot be set if manage_master_user_password is set to true.
masterUserSecretKmsKeyId string: Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. If not specified, the default KMS key for your Amazon Web Services account is used.
masterUserSecrets ClusterMasterUserSecret[]: Block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.
masterUsername string: Username for the master DB user. Please refer to the RDS Naming Constraints. This argument does not support in-place updates and cannot be changed during a restore from snapshot.
networkType string: Network type of the cluster. Valid values: IPV4, DUAL.
performanceInsightsEnabled boolean: Valid only for Non-Aurora Multi-AZ DB Clusters. Enables Performance Insights for the RDS Cluster
performanceInsightsKmsKeyId string: Valid only for Non-Aurora Multi-AZ DB Clusters. Specifies the KMS Key ID to encrypt Performance Insights data. If not specified, the default RDS KMS key will be used (aws/rds).
performanceInsightsRetentionPeriod number: Valid only for Non-Aurora Multi-AZ DB Clusters. Specifies the amount of time to retain performance insights data for. Defaults to 7 days if Performance Insights are enabled. Valid values are 7, month * 31 (where month is a number of months from 1-23), and 731. See here for more information on retention periods.
port number: Port on which the DB accepts connections.
preferredBackupWindow string: Daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC. Default: A 30-minute window selected at random from an 8-hour block of time per region, e.g. 04:00-09:00.
preferredMaintenanceWindow string: Weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
readerEndpoint string: Read-only endpoint for the Aurora cluster, automatically load-balanced across replicas
replicationSourceIdentifier string: ARN of a source DB cluster or DB instance if this DB cluster is to be created as a Read Replica. If DB Cluster is part of a Global Cluster, use the lifecycle configuration block ignore_changes argument to prevent this provider from showing differences for this argument instead of configuring this value.
restoreToPointInTime ClusterRestoreToPointInTime: Nested attribute for point in time restore. More details below.
s3Import ClusterS3Import
scalingConfiguration ClusterScalingConfiguration: Nested attribute with scaling properties. Only valid when engine_mode is set to serverless. More details below.
serverlessv2ScalingConfiguration ClusterServerlessv2ScalingConfiguration: Nested attribute with scaling properties for ServerlessV2. Only valid when engine_mode is set to provisioned. More details below.
skipFinalSnapshot boolean: Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from final_snapshot_identifier. Default is false.
snapshotIdentifier string: Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot. Conflicts with global_cluster_identifier. Clusters cannot be restored from snapshot and joined to an existing global cluster in a single operation. See the AWS documentation or the Global Cluster Restored From Snapshot example for instructions on building a global cluster starting with a snapshot.
sourceRegion string: The source region for an encrypted replica DB cluster.
storageEncrypted boolean: Specifies whether the DB cluster is encrypted. The default is false for provisioned engine_mode and true for serverless engine_mode. When restoring an unencrypted snapshot_identifier, the kms_key_id argument must be provided to encrypt the restored cluster. The provider will only perform drift detection if a configuration value is provided.
storageType string: (Forces new for Multi-AZ DB clusters) Specifies the storage type to be associated with the DB cluster. For Aurora DB clusters, storage_type modifications can be done in-place. For Multi-AZ DB Clusters, the iops argument must also be set. Valid values are: "", aurora-iopt1 (Aurora DB Clusters); io1, io2 (Multi-AZ DB Clusters). Default: "" (Aurora DB Clusters); io1 (Multi-AZ DB Clusters).
tags {[key: string]: string}: A map of tags to assign to the DB cluster. 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.
vpcSecurityGroupIds string[]: List of VPC security groups to associate with the Cluster

allocated_storage int: The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
allow_major_version_upgrade bool: Enable to allow major engine version upgrades when changing engine versions. Defaults to false.
apply_immediately bool: Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.
arn str: Amazon Resource Name (ARN) of cluster
availability_zones Sequence[str]: List of EC2 Availability Zones for the DB cluster storage where DB cluster instances can be created. RDS automatically assigns 3 AZs if less than 3 AZs are configured, which will show as a difference requiring resource recreation next pulumi up. We recommend specifying 3 AZs or using the lifecycle configuration block ignore_changes argument if necessary. A maximum of 3 AZs can be configured.
backtrack_window int: Target backtrack window, in seconds. Only available for aurora and aurora-mysql engines currently. To disable backtracking, set this value to 0. Defaults to 0. Must be between 0 and 259200 (72 hours)
backup_retention_period int: Days to retain backups for. Default 1
ca_certificate_identifier str: The CA certificate identifier to use for the DB cluster's server certificate.
ca_certificate_valid_till str: Expiration date of the DB instance’s server certificate
cluster_identifier str: The cluster identifier. If omitted, this provider will assign a random, unique identifier.
cluster_identifier_prefix str: Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
cluster_members Sequence[str]: List of RDS Instances that are a part of this cluster
cluster_resource_id str: RDS Cluster Resource ID
copy_tags_to_snapshot bool: Copy all Cluster tags to snapshots. Default is false.
database_name str: Name for an automatically created database on cluster creation. There are different naming restrictions per database engine: RDS Naming Constraints
db_cluster_instance_class str: The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide.
db_cluster_parameter_group_name str: A cluster parameter group to associate with the cluster.
db_instance_parameter_group_name str: Instance parameter group to associate with all instances of the DB cluster. The db_instance_parameter_group_name parameter is only valid in combination with the allow_major_version_upgrade parameter.
db_subnet_group_name str: DB subnet group to associate with this DB cluster. NOTE: This must match the db_subnet_group_name specified on every aws.rds.ClusterInstance in the cluster.
db_system_id str: For use with RDS Custom.
delete_automated_backups bool: Specifies whether to remove automated backups immediately after the DB cluster is deleted. Default is true.
deletion_protection bool: If the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.
domain str: The ID of the Directory Service Active Directory domain to create the cluster in.
domain_iam_role_name str: The name of the IAM role to be used when making API calls to the Directory Service.
enable_global_write_forwarding bool: Whether cluster should forward writes to an associated global cluster. Applied to secondary clusters to enable them to forward writes to an aws.rds.GlobalCluster's primary cluster. See the User Guide for Aurora for more information.
enable_http_endpoint bool: Enable HTTP endpoint (data API). Only valid for some combinations of engine_mode, engine and engine_version and only available in some regions. See the Region and version availability section of the documentation. This option also does not work with any of these options specified: snapshot_identifier, replication_source_identifier, s3_import.
enable_local_write_forwarding bool: Whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.. See the User Guide for Aurora for more information. NOTE: Local write forwarding requires Aurora MySQL version 3.04 or higher.
enabled_cloudwatch_logs_exports Sequence[str]: Set of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, error, general, slowquery, postgresql (PostgreSQL).
endpoint str: DNS address of the RDS instance
engine str | EngineType: Name of the database engine to be used for this DB cluster. Valid Values: aurora-mysql, aurora-postgresql, mysql, postgres. (Note that mysql and postgres are Multi-AZ RDS clusters).
engine_lifecycle_support str: The life cycle type for this DB instance. This setting is valid for cluster types Aurora DB clusters and Multi-AZ DB clusters. Valid values are open-source-rds-extended-support, open-source-rds-extended-support-disabled. Default value is open-source-rds-extended-support. [Using Amazon RDS Extended Support]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html
engine_mode str | EngineMode: Database engine mode. Valid values: global (only valid for Aurora MySQL 1.21 and earlier), parallelquery, provisioned, serverless. Defaults to: provisioned. See the RDS User Guide for limitations when using serverless.
engine_version str: Database engine version. Updating this argument results in an outage. See the Aurora MySQL and Aurora Postgres documentation for your configured engine to determine this value, or by running aws rds describe-db-engine-versions. For example with Aurora MySQL 2, a potential value for this argument is 5.7.mysql_aurora.2.03.2. The value can contain a partial version where supported by the API. The actual engine version used is returned in the attribute engine_version_actual, , see Attribute Reference below.
engine_version_actual str: Running version of the database.
final_snapshot_identifier str: Name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
global_cluster_identifier str: Global cluster identifier specified on aws.rds.GlobalCluster.
hosted_zone_id str: Route53 Hosted Zone ID of the endpoint
iam_database_authentication_enabled bool: Specifies whether or not mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Please see AWS Documentation for availability and limitations.
iam_roles Sequence[str]: List of ARNs for the IAM roles to associate to the RDS Cluster.
iops int: Amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. For information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide. (This setting is required to create a Multi-AZ DB cluster). Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
kms_key_id str: ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.
manage_master_user_password bool: Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if master_password is provided.
master_password str: Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the RDS Naming Constraints. Cannot be set if manage_master_user_password is set to true.
master_user_secret_kms_key_id str: Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. If not specified, the default KMS key for your Amazon Web Services account is used.
master_user_secrets Sequence[ClusterMasterUserSecretArgs]: Block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.
master_username str: Username for the master DB user. Please refer to the RDS Naming Constraints. This argument does not support in-place updates and cannot be changed during a restore from snapshot.
network_type str: Network type of the cluster. Valid values: IPV4, DUAL.
performance_insights_enabled bool: Valid only for Non-Aurora Multi-AZ DB Clusters. Enables Performance Insights for the RDS Cluster
performance_insights_kms_key_id str: Valid only for Non-Aurora Multi-AZ DB Clusters. Specifies the KMS Key ID to encrypt Performance Insights data. If not specified, the default RDS KMS key will be used (aws/rds).
performance_insights_retention_period int: Valid only for Non-Aurora Multi-AZ DB Clusters. Specifies the amount of time to retain performance insights data for. Defaults to 7 days if Performance Insights are enabled. Valid values are 7, month * 31 (where month is a number of months from 1-23), and 731. See here for more information on retention periods.
port int: Port on which the DB accepts connections.
preferred_backup_window str: Daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC. Default: A 30-minute window selected at random from an 8-hour block of time per region, e.g. 04:00-09:00.
preferred_maintenance_window str: Weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
reader_endpoint str: Read-only endpoint for the Aurora cluster, automatically load-balanced across replicas
replication_source_identifier str: ARN of a source DB cluster or DB instance if this DB cluster is to be created as a Read Replica. If DB Cluster is part of a Global Cluster, use the lifecycle configuration block ignore_changes argument to prevent this provider from showing differences for this argument instead of configuring this value.
restore_to_point_in_time ClusterRestoreToPointInTimeArgs: Nested attribute for point in time restore. More details below.
s3_import ClusterS3ImportArgs
scaling_configuration ClusterScalingConfigurationArgs: Nested attribute with scaling properties. Only valid when engine_mode is set to serverless. More details below.
serverlessv2_scaling_configuration ClusterServerlessv2ScalingConfigurationArgs: Nested attribute with scaling properties for ServerlessV2. Only valid when engine_mode is set to provisioned. More details below.
skip_final_snapshot bool: Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from final_snapshot_identifier. Default is false.
snapshot_identifier str: Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot. Conflicts with global_cluster_identifier. Clusters cannot be restored from snapshot and joined to an existing global cluster in a single operation. See the AWS documentation or the Global Cluster Restored From Snapshot example for instructions on building a global cluster starting with a snapshot.
source_region str: The source region for an encrypted replica DB cluster.
storage_encrypted bool: Specifies whether the DB cluster is encrypted. The default is false for provisioned engine_mode and true for serverless engine_mode. When restoring an unencrypted snapshot_identifier, the kms_key_id argument must be provided to encrypt the restored cluster. The provider will only perform drift detection if a configuration value is provided.
storage_type str: (Forces new for Multi-AZ DB clusters) Specifies the storage type to be associated with the DB cluster. For Aurora DB clusters, storage_type modifications can be done in-place. For Multi-AZ DB Clusters, the iops argument must also be set. Valid values are: "", aurora-iopt1 (Aurora DB Clusters); io1, io2 (Multi-AZ DB Clusters). Default: "" (Aurora DB Clusters); io1 (Multi-AZ DB Clusters).
tags Mapping[str, str]: A map of tags to assign to the DB cluster. 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.
vpc_security_group_ids Sequence[str]: List of VPC security groups to associate with the Cluster

allocatedStorage Number: The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
allowMajorVersionUpgrade Boolean: Enable to allow major engine version upgrades when changing engine versions. Defaults to false.
applyImmediately Boolean: Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.
arn String: Amazon Resource Name (ARN) of cluster
availabilityZones List<String>: List of EC2 Availability Zones for the DB cluster storage where DB cluster instances can be created. RDS automatically assigns 3 AZs if less than 3 AZs are configured, which will show as a difference requiring resource recreation next pulumi up. We recommend specifying 3 AZs or using the lifecycle configuration block ignore_changes argument if necessary. A maximum of 3 AZs can be configured.
backtrackWindow Number: Target backtrack window, in seconds. Only available for aurora and aurora-mysql engines currently. To disable backtracking, set this value to 0. Defaults to 0. Must be between 0 and 259200 (72 hours)
backupRetentionPeriod Number: Days to retain backups for. Default 1
caCertificateIdentifier String: The CA certificate identifier to use for the DB cluster's server certificate.
caCertificateValidTill String: Expiration date of the DB instance’s server certificate
clusterIdentifier String: The cluster identifier. If omitted, this provider will assign a random, unique identifier.
clusterIdentifierPrefix String: Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
clusterMembers List<String>: List of RDS Instances that are a part of this cluster
clusterResourceId String: RDS Cluster Resource ID
copyTagsToSnapshot Boolean: Copy all Cluster tags to snapshots. Default is false.
databaseName String: Name for an automatically created database on cluster creation. There are different naming restrictions per database engine: RDS Naming Constraints
dbClusterInstanceClass String: The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide.
dbClusterParameterGroupName String: A cluster parameter group to associate with the cluster.
dbInstanceParameterGroupName String: Instance parameter group to associate with all instances of the DB cluster. The db_instance_parameter_group_name parameter is only valid in combination with the allow_major_version_upgrade parameter.
dbSubnetGroupName String: DB subnet group to associate with this DB cluster. NOTE: This must match the db_subnet_group_name specified on every aws.rds.ClusterInstance in the cluster.
dbSystemId String: For use with RDS Custom.
deleteAutomatedBackups Boolean: Specifies whether to remove automated backups immediately after the DB cluster is deleted. Default is true.
deletionProtection Boolean: If the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.
domain String: The ID of the Directory Service Active Directory domain to create the cluster in.
domainIamRoleName String: The name of the IAM role to be used when making API calls to the Directory Service.
enableGlobalWriteForwarding Boolean: Whether cluster should forward writes to an associated global cluster. Applied to secondary clusters to enable them to forward writes to an aws.rds.GlobalCluster's primary cluster. See the User Guide for Aurora for more information.
enableHttpEndpoint Boolean: Enable HTTP endpoint (data API). Only valid for some combinations of engine_mode, engine and engine_version and only available in some regions. See the Region and version availability section of the documentation. This option also does not work with any of these options specified: snapshot_identifier, replication_source_identifier, s3_import.
enableLocalWriteForwarding Boolean: Whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.. See the User Guide for Aurora for more information. NOTE: Local write forwarding requires Aurora MySQL version 3.04 or higher.
enabledCloudwatchLogsExports List<String>: Set of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, error, general, slowquery, postgresql (PostgreSQL).
endpoint String: DNS address of the RDS instance
engine String | "aurora" | "aurora-mysql" | "aurora-postgresql": Name of the database engine to be used for this DB cluster. Valid Values: aurora-mysql, aurora-postgresql, mysql, postgres. (Note that mysql and postgres are Multi-AZ RDS clusters).
engineLifecycleSupport String: The life cycle type for this DB instance. This setting is valid for cluster types Aurora DB clusters and Multi-AZ DB clusters. Valid values are open-source-rds-extended-support, open-source-rds-extended-support-disabled. Default value is open-source-rds-extended-support. [Using Amazon RDS Extended Support]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html
engineMode String | "provisioned" | "serverless" | "parallelquery" | "global": Database engine mode. Valid values: global (only valid for Aurora MySQL 1.21 and earlier), parallelquery, provisioned, serverless. Defaults to: provisioned. See the RDS User Guide for limitations when using serverless.
engineVersion String: Database engine version. Updating this argument results in an outage. See the Aurora MySQL and Aurora Postgres documentation for your configured engine to determine this value, or by running aws rds describe-db-engine-versions. For example with Aurora MySQL 2, a potential value for this argument is 5.7.mysql_aurora.2.03.2. The value can contain a partial version where supported by the API. The actual engine version used is returned in the attribute engine_version_actual, , see Attribute Reference below.
engineVersionActual String: Running version of the database.
finalSnapshotIdentifier String: Name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
globalClusterIdentifier String: Global cluster identifier specified on aws.rds.GlobalCluster.
hostedZoneId String: Route53 Hosted Zone ID of the endpoint
iamDatabaseAuthenticationEnabled Boolean: Specifies whether or not mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Please see AWS Documentation for availability and limitations.
iamRoles List<String>: List of ARNs for the IAM roles to associate to the RDS Cluster.
iops Number: Amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. For information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide. (This setting is required to create a Multi-AZ DB cluster). Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
kmsKeyId String: ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.
manageMasterUserPassword Boolean: Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if master_password is provided.
masterPassword String: Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the RDS Naming Constraints. Cannot be set if manage_master_user_password is set to true.
masterUserSecretKmsKeyId String: Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. If not specified, the default KMS key for your Amazon Web Services account is used.
masterUserSecrets List<Property Map>: Block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.
masterUsername String: Username for the master DB user. Please refer to the RDS Naming Constraints. This argument does not support in-place updates and cannot be changed during a restore from snapshot.
networkType String: Network type of the cluster. Valid values: IPV4, DUAL.
performanceInsightsEnabled Boolean: Valid only for Non-Aurora Multi-AZ DB Clusters. Enables Performance Insights for the RDS Cluster
performanceInsightsKmsKeyId String: Valid only for Non-Aurora Multi-AZ DB Clusters. Specifies the KMS Key ID to encrypt Performance Insights data. If not specified, the default RDS KMS key will be used (aws/rds).
performanceInsightsRetentionPeriod Number: Valid only for Non-Aurora Multi-AZ DB Clusters. Specifies the amount of time to retain performance insights data for. Defaults to 7 days if Performance Insights are enabled. Valid values are 7, month * 31 (where month is a number of months from 1-23), and 731. See here for more information on retention periods.
port Number: Port on which the DB accepts connections.
preferredBackupWindow String: Daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC. Default: A 30-minute window selected at random from an 8-hour block of time per region, e.g. 04:00-09:00.
preferredMaintenanceWindow String: Weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
readerEndpoint String: Read-only endpoint for the Aurora cluster, automatically load-balanced across replicas
replicationSourceIdentifier String: ARN of a source DB cluster or DB instance if this DB cluster is to be created as a Read Replica. If DB Cluster is part of a Global Cluster, use the lifecycle configuration block ignore_changes argument to prevent this provider from showing differences for this argument instead of configuring this value.
restoreToPointInTime Property Map: Nested attribute for point in time restore. More details below.
s3Import Property Map
scalingConfiguration Property Map: Nested attribute with scaling properties. Only valid when engine_mode is set to serverless. More details below.
serverlessv2ScalingConfiguration Property Map: Nested attribute with scaling properties for ServerlessV2. Only valid when engine_mode is set to provisioned. More details below.
skipFinalSnapshot Boolean: Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from final_snapshot_identifier. Default is false.
snapshotIdentifier String: Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot. Conflicts with global_cluster_identifier. Clusters cannot be restored from snapshot and joined to an existing global cluster in a single operation. See the AWS documentation or the Global Cluster Restored From Snapshot example for instructions on building a global cluster starting with a snapshot.
sourceRegion String: The source region for an encrypted replica DB cluster.
storageEncrypted Boolean: Specifies whether the DB cluster is encrypted. The default is false for provisioned engine_mode and true for serverless engine_mode. When restoring an unencrypted snapshot_identifier, the kms_key_id argument must be provided to encrypt the restored cluster. The provider will only perform drift detection if a configuration value is provided.
storageType String: (Forces new for Multi-AZ DB clusters) Specifies the storage type to be associated with the DB cluster. For Aurora DB clusters, storage_type modifications can be done in-place. For Multi-AZ DB Clusters, the iops argument must also be set. Valid values are: "", aurora-iopt1 (Aurora DB Clusters); io1, io2 (Multi-AZ DB Clusters). Default: "" (Aurora DB Clusters); io1 (Multi-AZ DB Clusters).
tags Map<String>: A map of tags to assign to the DB cluster. 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.
vpcSecurityGroupIds List<String>: List of VPC security groups to associate with the Cluster

Supporting Types

ClusterMasterUserSecret, ClusterMasterUserSecretArgs

KmsKeyId string: ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.
SecretArn string: Amazon Resource Name (ARN) of the secret.
SecretStatus string: Status of the secret. Valid Values: creating | active | rotating | impaired.

KmsKeyId string: ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.
SecretArn string: Amazon Resource Name (ARN) of the secret.
SecretStatus string: Status of the secret. Valid Values: creating | active | rotating | impaired.

kmsKeyId String: ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.
secretArn String: Amazon Resource Name (ARN) of the secret.
secretStatus String: Status of the secret. Valid Values: creating | active | rotating | impaired.

kmsKeyId string: ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.
secretArn string: Amazon Resource Name (ARN) of the secret.
secretStatus string: Status of the secret. Valid Values: creating | active | rotating | impaired.

kms_key_id str: ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.
secret_arn str: Amazon Resource Name (ARN) of the secret.
secret_status str: Status of the secret. Valid Values: creating | active | rotating | impaired.

kmsKeyId String: ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.
secretArn String: Amazon Resource Name (ARN) of the secret.
secretStatus String: Status of the secret. Valid Values: creating | active | rotating | impaired.

ClusterRestoreToPointInTime, ClusterRestoreToPointInTimeArgs

RestoreToTime string: Date and time in UTC format to restore the database cluster to. Conflicts with use_latest_restorable_time.
RestoreType string: Type of restore to be performed. Valid options are full-copy (default) and copy-on-write.
SourceClusterIdentifier string: Identifier of the source database cluster from which to restore. When restoring from a cluster in another AWS account, the identifier is the ARN of that cluster.
SourceClusterResourceId string: Cluster resource ID of the source database cluster from which to restore. To be used for restoring a deleted cluster in the same account which still has a retained automatic backup available.
UseLatestRestorableTime bool: Set to true to restore the database cluster to the latest restorable backup time. Defaults to false. Conflicts with restore_to_time.

RestoreToTime string: Date and time in UTC format to restore the database cluster to. Conflicts with use_latest_restorable_time.
RestoreType string: Type of restore to be performed. Valid options are full-copy (default) and copy-on-write.
SourceClusterIdentifier string: Identifier of the source database cluster from which to restore. When restoring from a cluster in another AWS account, the identifier is the ARN of that cluster.
SourceClusterResourceId string: Cluster resource ID of the source database cluster from which to restore. To be used for restoring a deleted cluster in the same account which still has a retained automatic backup available.
UseLatestRestorableTime bool: Set to true to restore the database cluster to the latest restorable backup time. Defaults to false. Conflicts with restore_to_time.

restoreToTime String: Date and time in UTC format to restore the database cluster to. Conflicts with use_latest_restorable_time.
restoreType String: Type of restore to be performed. Valid options are full-copy (default) and copy-on-write.
sourceClusterIdentifier String: Identifier of the source database cluster from which to restore. When restoring from a cluster in another AWS account, the identifier is the ARN of that cluster.
sourceClusterResourceId String: Cluster resource ID of the source database cluster from which to restore. To be used for restoring a deleted cluster in the same account which still has a retained automatic backup available.
useLatestRestorableTime Boolean: Set to true to restore the database cluster to the latest restorable backup time. Defaults to false. Conflicts with restore_to_time.

restoreToTime string: Date and time in UTC format to restore the database cluster to. Conflicts with use_latest_restorable_time.
restoreType string: Type of restore to be performed. Valid options are full-copy (default) and copy-on-write.
sourceClusterIdentifier string: Identifier of the source database cluster from which to restore. When restoring from a cluster in another AWS account, the identifier is the ARN of that cluster.
sourceClusterResourceId string: Cluster resource ID of the source database cluster from which to restore. To be used for restoring a deleted cluster in the same account which still has a retained automatic backup available.
useLatestRestorableTime boolean: Set to true to restore the database cluster to the latest restorable backup time. Defaults to false. Conflicts with restore_to_time.

restore_to_time str: Date and time in UTC format to restore the database cluster to. Conflicts with use_latest_restorable_time.
restore_type str: Type of restore to be performed. Valid options are full-copy (default) and copy-on-write.
source_cluster_identifier str: Identifier of the source database cluster from which to restore. When restoring from a cluster in another AWS account, the identifier is the ARN of that cluster.
source_cluster_resource_id str: Cluster resource ID of the source database cluster from which to restore. To be used for restoring a deleted cluster in the same account which still has a retained automatic backup available.
use_latest_restorable_time bool: Set to true to restore the database cluster to the latest restorable backup time. Defaults to false. Conflicts with restore_to_time.

restoreToTime String: Date and time in UTC format to restore the database cluster to. Conflicts with use_latest_restorable_time.
restoreType String: Type of restore to be performed. Valid options are full-copy (default) and copy-on-write.
sourceClusterIdentifier String: Identifier of the source database cluster from which to restore. When restoring from a cluster in another AWS account, the identifier is the ARN of that cluster.
sourceClusterResourceId String: Cluster resource ID of the source database cluster from which to restore. To be used for restoring a deleted cluster in the same account which still has a retained automatic backup available.
useLatestRestorableTime Boolean: Set to true to restore the database cluster to the latest restorable backup time. Defaults to false. Conflicts with restore_to_time.

ClusterS3Import, ClusterS3ImportArgs

BucketName string

Bucket name where your backup is stored

IngestionRole string

Role applied to load the data.

SourceEngine string

Source engine for the backup

SourceEngineVersion string

Version of the source engine used to make the backup

This will not recreate the resource if the S3 object changes in some way. It's only used to initialize the database. This only works currently with the aurora engine. See AWS for currently supported engines and options. See Aurora S3 Migration Docs.

BucketPrefix string

Can be blank, but is the path to your backup

BucketName string

Bucket name where your backup is stored

IngestionRole string

Role applied to load the data.

SourceEngine string

Source engine for the backup

SourceEngineVersion string

Version of the source engine used to make the backup

BucketPrefix string

Can be blank, but is the path to your backup

bucketName String

Bucket name where your backup is stored

ingestionRole String

Role applied to load the data.

sourceEngine String

Source engine for the backup

sourceEngineVersion String

Version of the source engine used to make the backup

bucketPrefix String

Can be blank, but is the path to your backup

bucketName string

Bucket name where your backup is stored

ingestionRole string

Role applied to load the data.

sourceEngine string

Source engine for the backup

sourceEngineVersion string

Version of the source engine used to make the backup

bucketPrefix string

Can be blank, but is the path to your backup

bucket_name str

Bucket name where your backup is stored

ingestion_role str

Role applied to load the data.

source_engine str

Source engine for the backup

source_engine_version str

Version of the source engine used to make the backup

bucket_prefix str

Can be blank, but is the path to your backup

bucketName String

Bucket name where your backup is stored

ingestionRole String

Role applied to load the data.

sourceEngine String

Source engine for the backup

sourceEngineVersion String

Version of the source engine used to make the backup

bucketPrefix String

Can be blank, but is the path to your backup

ClusterScalingConfiguration, ClusterScalingConfigurationArgs

AutoPause bool: Whether to enable automatic pause. A DB cluster can be paused only when it's idle (it has no connections). If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it. Defaults to true.
MaxCapacity int: Maximum capacity for an Aurora DB cluster in serverless DB engine mode. The maximum capacity must be greater than or equal to the minimum capacity. Valid Aurora MySQL capacity values are 1, 2, 4, 8, 16, 32, 64, 128, 256. Valid Aurora PostgreSQL capacity values are (2, 4, 8, 16, 32, 64, 192, and 384). Defaults to 16.
MinCapacity int: Minimum capacity for an Aurora DB cluster in serverless DB engine mode. The minimum capacity must be lesser than or equal to the maximum capacity. Valid Aurora MySQL capacity values are 1, 2, 4, 8, 16, 32, 64, 128, 256. Valid Aurora PostgreSQL capacity values are (2, 4, 8, 16, 32, 64, 192, and 384). Defaults to 1.
SecondsBeforeTimeout int: Amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. Valid values are 60 through 600. Defaults to 300.
SecondsUntilAutoPause int: Time, in seconds, before an Aurora DB cluster in serverless mode is paused. Valid values are 300 through 86400. Defaults to 300.
TimeoutAction string: Action to take when the timeout is reached. Valid values: ForceApplyCapacityChange, RollbackCapacityChange. Defaults to RollbackCapacityChange. See documentation.

AutoPause bool: Whether to enable automatic pause. A DB cluster can be paused only when it's idle (it has no connections). If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it. Defaults to true.
MaxCapacity int: Maximum capacity for an Aurora DB cluster in serverless DB engine mode. The maximum capacity must be greater than or equal to the minimum capacity. Valid Aurora MySQL capacity values are 1, 2, 4, 8, 16, 32, 64, 128, 256. Valid Aurora PostgreSQL capacity values are (2, 4, 8, 16, 32, 64, 192, and 384). Defaults to 16.
MinCapacity int: Minimum capacity for an Aurora DB cluster in serverless DB engine mode. The minimum capacity must be lesser than or equal to the maximum capacity. Valid Aurora MySQL capacity values are 1, 2, 4, 8, 16, 32, 64, 128, 256. Valid Aurora PostgreSQL capacity values are (2, 4, 8, 16, 32, 64, 192, and 384). Defaults to 1.
SecondsBeforeTimeout int: Amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. Valid values are 60 through 600. Defaults to 300.
SecondsUntilAutoPause int: Time, in seconds, before an Aurora DB cluster in serverless mode is paused. Valid values are 300 through 86400. Defaults to 300.
TimeoutAction string: Action to take when the timeout is reached. Valid values: ForceApplyCapacityChange, RollbackCapacityChange. Defaults to RollbackCapacityChange. See documentation.

autoPause Boolean: Whether to enable automatic pause. A DB cluster can be paused only when it's idle (it has no connections). If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it. Defaults to true.
maxCapacity Integer: Maximum capacity for an Aurora DB cluster in serverless DB engine mode. The maximum capacity must be greater than or equal to the minimum capacity. Valid Aurora MySQL capacity values are 1, 2, 4, 8, 16, 32, 64, 128, 256. Valid Aurora PostgreSQL capacity values are (2, 4, 8, 16, 32, 64, 192, and 384). Defaults to 16.
minCapacity Integer: Minimum capacity for an Aurora DB cluster in serverless DB engine mode. The minimum capacity must be lesser than or equal to the maximum capacity. Valid Aurora MySQL capacity values are 1, 2, 4, 8, 16, 32, 64, 128, 256. Valid Aurora PostgreSQL capacity values are (2, 4, 8, 16, 32, 64, 192, and 384). Defaults to 1.
secondsBeforeTimeout Integer: Amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. Valid values are 60 through 600. Defaults to 300.
secondsUntilAutoPause Integer: Time, in seconds, before an Aurora DB cluster in serverless mode is paused. Valid values are 300 through 86400. Defaults to 300.
timeoutAction String: Action to take when the timeout is reached. Valid values: ForceApplyCapacityChange, RollbackCapacityChange. Defaults to RollbackCapacityChange. See documentation.

autoPause boolean: Whether to enable automatic pause. A DB cluster can be paused only when it's idle (it has no connections). If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it. Defaults to true.
maxCapacity number: Maximum capacity for an Aurora DB cluster in serverless DB engine mode. The maximum capacity must be greater than or equal to the minimum capacity. Valid Aurora MySQL capacity values are 1, 2, 4, 8, 16, 32, 64, 128, 256. Valid Aurora PostgreSQL capacity values are (2, 4, 8, 16, 32, 64, 192, and 384). Defaults to 16.
minCapacity number: Minimum capacity for an Aurora DB cluster in serverless DB engine mode. The minimum capacity must be lesser than or equal to the maximum capacity. Valid Aurora MySQL capacity values are 1, 2, 4, 8, 16, 32, 64, 128, 256. Valid Aurora PostgreSQL capacity values are (2, 4, 8, 16, 32, 64, 192, and 384). Defaults to 1.
secondsBeforeTimeout number: Amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. Valid values are 60 through 600. Defaults to 300.
secondsUntilAutoPause number: Time, in seconds, before an Aurora DB cluster in serverless mode is paused. Valid values are 300 through 86400. Defaults to 300.
timeoutAction string: Action to take when the timeout is reached. Valid values: ForceApplyCapacityChange, RollbackCapacityChange. Defaults to RollbackCapacityChange. See documentation.

auto_pause bool: Whether to enable automatic pause. A DB cluster can be paused only when it's idle (it has no connections). If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it. Defaults to true.
max_capacity int: Maximum capacity for an Aurora DB cluster in serverless DB engine mode. The maximum capacity must be greater than or equal to the minimum capacity. Valid Aurora MySQL capacity values are 1, 2, 4, 8, 16, 32, 64, 128, 256. Valid Aurora PostgreSQL capacity values are (2, 4, 8, 16, 32, 64, 192, and 384). Defaults to 16.
min_capacity int: Minimum capacity for an Aurora DB cluster in serverless DB engine mode. The minimum capacity must be lesser than or equal to the maximum capacity. Valid Aurora MySQL capacity values are 1, 2, 4, 8, 16, 32, 64, 128, 256. Valid Aurora PostgreSQL capacity values are (2, 4, 8, 16, 32, 64, 192, and 384). Defaults to 1.
seconds_before_timeout int: Amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. Valid values are 60 through 600. Defaults to 300.
seconds_until_auto_pause int: Time, in seconds, before an Aurora DB cluster in serverless mode is paused. Valid values are 300 through 86400. Defaults to 300.
timeout_action str: Action to take when the timeout is reached. Valid values: ForceApplyCapacityChange, RollbackCapacityChange. Defaults to RollbackCapacityChange. See documentation.

autoPause Boolean: Whether to enable automatic pause. A DB cluster can be paused only when it's idle (it has no connections). If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it. Defaults to true.
maxCapacity Number: Maximum capacity for an Aurora DB cluster in serverless DB engine mode. The maximum capacity must be greater than or equal to the minimum capacity. Valid Aurora MySQL capacity values are 1, 2, 4, 8, 16, 32, 64, 128, 256. Valid Aurora PostgreSQL capacity values are (2, 4, 8, 16, 32, 64, 192, and 384). Defaults to 16.
minCapacity Number: Minimum capacity for an Aurora DB cluster in serverless DB engine mode. The minimum capacity must be lesser than or equal to the maximum capacity. Valid Aurora MySQL capacity values are 1, 2, 4, 8, 16, 32, 64, 128, 256. Valid Aurora PostgreSQL capacity values are (2, 4, 8, 16, 32, 64, 192, and 384). Defaults to 1.
secondsBeforeTimeout Number: Amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. Valid values are 60 through 600. Defaults to 300.
secondsUntilAutoPause Number: Time, in seconds, before an Aurora DB cluster in serverless mode is paused. Valid values are 300 through 86400. Defaults to 300.
timeoutAction String: Action to take when the timeout is reached. Valid values: ForceApplyCapacityChange, RollbackCapacityChange. Defaults to RollbackCapacityChange. See documentation.

ClusterServerlessv2ScalingConfiguration, ClusterServerlessv2ScalingConfigurationArgs

MaxCapacity double: Maximum capacity for an Aurora DB cluster in provisioned DB engine mode. The maximum capacity must be greater than or equal to the minimum capacity. Valid capacity values are in a range of 0.5 up to 128 in steps of 0.5.
MinCapacity double: Minimum capacity for an Aurora DB cluster in provisioned DB engine mode. The minimum capacity must be lesser than or equal to the maximum capacity. Valid capacity values are in a range of 0.5 up to 128 in steps of 0.5.

MaxCapacity float64: Maximum capacity for an Aurora DB cluster in provisioned DB engine mode. The maximum capacity must be greater than or equal to the minimum capacity. Valid capacity values are in a range of 0.5 up to 128 in steps of 0.5.
MinCapacity float64: Minimum capacity for an Aurora DB cluster in provisioned DB engine mode. The minimum capacity must be lesser than or equal to the maximum capacity. Valid capacity values are in a range of 0.5 up to 128 in steps of 0.5.

maxCapacity Double: Maximum capacity for an Aurora DB cluster in provisioned DB engine mode. The maximum capacity must be greater than or equal to the minimum capacity. Valid capacity values are in a range of 0.5 up to 128 in steps of 0.5.
minCapacity Double: Minimum capacity for an Aurora DB cluster in provisioned DB engine mode. The minimum capacity must be lesser than or equal to the maximum capacity. Valid capacity values are in a range of 0.5 up to 128 in steps of 0.5.

maxCapacity number: Maximum capacity for an Aurora DB cluster in provisioned DB engine mode. The maximum capacity must be greater than or equal to the minimum capacity. Valid capacity values are in a range of 0.5 up to 128 in steps of 0.5.
minCapacity number: Minimum capacity for an Aurora DB cluster in provisioned DB engine mode. The minimum capacity must be lesser than or equal to the maximum capacity. Valid capacity values are in a range of 0.5 up to 128 in steps of 0.5.

max_capacity float: Maximum capacity for an Aurora DB cluster in provisioned DB engine mode. The maximum capacity must be greater than or equal to the minimum capacity. Valid capacity values are in a range of 0.5 up to 128 in steps of 0.5.
min_capacity float: Minimum capacity for an Aurora DB cluster in provisioned DB engine mode. The minimum capacity must be lesser than or equal to the maximum capacity. Valid capacity values are in a range of 0.5 up to 128 in steps of 0.5.

maxCapacity Number: Maximum capacity for an Aurora DB cluster in provisioned DB engine mode. The maximum capacity must be greater than or equal to the minimum capacity. Valid capacity values are in a range of 0.5 up to 128 in steps of 0.5.
minCapacity Number: Minimum capacity for an Aurora DB cluster in provisioned DB engine mode. The minimum capacity must be lesser than or equal to the maximum capacity. Valid capacity values are in a range of 0.5 up to 128 in steps of 0.5.

EngineMode, EngineModeArgs

Provisioned: provisioned
Serverless: serverless
ParallelQuery: parallelquery
Global: global

EngineModeProvisioned: provisioned
EngineModeServerless: serverless
EngineModeParallelQuery: parallelquery
EngineModeGlobal: global

Provisioned: provisioned
Serverless: serverless
ParallelQuery: parallelquery
Global: global

Provisioned: provisioned
Serverless: serverless
ParallelQuery: parallelquery
Global: global

PROVISIONED: provisioned
SERVERLESS: serverless
PARALLEL_QUERY: parallelquery
GLOBAL_: global

"provisioned": provisioned
"serverless": serverless
"parallelquery": parallelquery
"global": global

EngineType, EngineTypeArgs

Aurora: aurora
AuroraMysql: aurora-mysql
AuroraPostgresql: aurora-postgresql

EngineTypeAurora: aurora
EngineTypeAuroraMysql: aurora-mysql
EngineTypeAuroraPostgresql: aurora-postgresql

Aurora: aurora
AuroraMysql: aurora-mysql
AuroraPostgresql: aurora-postgresql

Aurora: aurora
AuroraMysql: aurora-mysql
AuroraPostgresql: aurora-postgresql

AURORA: aurora
AURORA_MYSQL: aurora-mysql
AURORA_POSTGRESQL: aurora-postgresql

"aurora": aurora
"aurora-mysql": aurora-mysql
"aurora-postgresql": aurora-postgresql

Import

Using pulumi import, import RDS Clusters using the cluster_identifier. For example:

$ pulumi import aws:rds/cluster:Cluster aurora_cluster aurora-prod-cluster

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.54.0 published on Friday, Sep 27, 2024 by Pulumi

pulumi/pulumi-aws

aws.rds.Cluster

On this page

On this page

Example Usage

Aurora MySQL 2.x (MySQL 5.7)

Aurora MySQL 1.x (MySQL 5.6)

Aurora with PostgreSQL engine

RDS Multi-AZ Cluster

RDS Serverless v2 Cluster

RDS/Aurora Managed Master Passwords via Secrets Manager, default KMS Key

RDS/Aurora Managed Master Passwords via Secrets Manager, specific KMS Key

Global Cluster Restored From Snapshot

Create Cluster Resource

Constructor syntax

Parameters

Constructor example

Cluster Resource Properties

Inputs

Outputs

Look up Existing Cluster Resource

Supporting Types

ClusterMasterUserSecret, ClusterMasterUserSecretArgs

ClusterRestoreToPointInTime, ClusterRestoreToPointInTimeArgs

ClusterS3Import, ClusterS3ImportArgs

ClusterScalingConfiguration, ClusterScalingConfigurationArgs

ClusterServerlessv2ScalingConfiguration, ClusterServerlessv2ScalingConfigurationArgs

EngineMode, EngineModeArgs

EngineType, EngineTypeArgs

Import

Package Details

On this page

On this page