AWS Classic v5.41.0, May 15 23

aws.rds.Cluster

Explore with Pulumi AI

Manages a RDS Aurora 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 databases (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: using apply_immediately can result in a brief downtime as the server reboots. See the AWS Docs on RDS Maintenance for more information.

Example Usage

Aurora MySQL 2.x (MySQL 5.7)

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()
    {
        AvailabilityZones = new[]
        {
            "us-west-2a",
            "us-west-2b",
            "us-west-2c",
        },
        BackupRetentionPeriod = 5,
        ClusterIdentifier = "aurora-cluster-demo",
        DatabaseName = "mydb",
        Engine = "aurora-mysql",
        EngineVersion = "5.7.mysql_aurora.2.03.2",
        MasterPassword = "bar",
        MasterUsername = "foo",
        PreferredBackupWindow = "07:00-09:00",
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/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{
			AvailabilityZones: pulumi.StringArray{
				pulumi.String("us-west-2a"),
				pulumi.String("us-west-2b"),
				pulumi.String("us-west-2c"),
			},
			BackupRetentionPeriod: pulumi.Int(5),
			ClusterIdentifier:     pulumi.String("aurora-cluster-demo"),
			DatabaseName:          pulumi.String("mydb"),
			Engine:                pulumi.String("aurora-mysql"),
			EngineVersion:         pulumi.String("5.7.mysql_aurora.2.03.2"),
			MasterPassword:        pulumi.String("bar"),
			MasterUsername:        pulumi.String("foo"),
			PreferredBackupWindow: pulumi.String("07:00-09:00"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

    }
}

import pulumi
import pulumi_aws as aws

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

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

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

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

Aurora MySQL 1.x (MySQL 5.6)

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()
    {
        AvailabilityZones = new[]
        {
            "us-west-2a",
            "us-west-2b",
            "us-west-2c",
        },
        BackupRetentionPeriod = 5,
        ClusterIdentifier = "aurora-cluster-demo",
        DatabaseName = "mydb",
        MasterPassword = "bar",
        MasterUsername = "foo",
        PreferredBackupWindow = "07:00-09:00",
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/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{
			AvailabilityZones: pulumi.StringArray{
				pulumi.String("us-west-2a"),
				pulumi.String("us-west-2b"),
				pulumi.String("us-west-2c"),
			},
			BackupRetentionPeriod: pulumi.Int(5),
			ClusterIdentifier:     pulumi.String("aurora-cluster-demo"),
			DatabaseName:          pulumi.String("mydb"),
			MasterPassword:        pulumi.String("bar"),
			MasterUsername:        pulumi.String("foo"),
			PreferredBackupWindow: pulumi.String("07:00-09:00"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

    }
}

import pulumi
import pulumi_aws as aws

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

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

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

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

Aurora with PostgreSQL engine

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()
    {
        AvailabilityZones = new[]
        {
            "us-west-2a",
            "us-west-2b",
            "us-west-2c",
        },
        BackupRetentionPeriod = 5,
        ClusterIdentifier = "aurora-cluster-demo",
        DatabaseName = "mydb",
        Engine = "aurora-postgresql",
        MasterPassword = "bar",
        MasterUsername = "foo",
        PreferredBackupWindow = "07:00-09:00",
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/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{
			AvailabilityZones: pulumi.StringArray{
				pulumi.String("us-west-2a"),
				pulumi.String("us-west-2b"),
				pulumi.String("us-west-2c"),
			},
			BackupRetentionPeriod: pulumi.Int(5),
			ClusterIdentifier:     pulumi.String("aurora-cluster-demo"),
			DatabaseName:          pulumi.String("mydb"),
			Engine:                pulumi.String("aurora-postgresql"),
			MasterPassword:        pulumi.String("bar"),
			MasterUsername:        pulumi.String("foo"),
			PreferredBackupWindow: pulumi.String("07:00-09:00"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

    }
}

import pulumi
import pulumi_aws as aws

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

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

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

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

Aurora Multi-Master Cluster

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",
        DbSubnetGroupName = aws_db_subnet_group.Example.Name,
        EngineMode = "multimaster",
        MasterPassword = "barbarbarbar",
        MasterUsername = "foo",
        SkipFinalSnapshot = true,
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/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"),
			DbSubnetGroupName: pulumi.Any(aws_db_subnet_group.Example.Name),
			EngineMode:        pulumi.String("multimaster"),
			MasterPassword:    pulumi.String("barbarbarbar"),
			MasterUsername:    pulumi.String("foo"),
			SkipFinalSnapshot: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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")
            .dbSubnetGroupName(aws_db_subnet_group.example().name())
            .engineMode("multimaster")
            .masterPassword("barbarbarbar")
            .masterUsername("foo")
            .skipFinalSnapshot(true)
            .build());

    }
}

import pulumi
import pulumi_aws as aws

example = aws.rds.Cluster("example",
    cluster_identifier="example",
    db_subnet_group_name=aws_db_subnet_group["example"]["name"],
    engine_mode="multimaster",
    master_password="barbarbarbar",
    master_username="foo",
    skip_final_snapshot=True)

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

const example = new aws.rds.Cluster("example", {
    clusterIdentifier: "example",
    dbSubnetGroupName: aws_db_subnet_group.example.name,
    engineMode: "multimaster",
    masterPassword: "barbarbarbar",
    masterUsername: "foo",
    skipFinalSnapshot: true,
});

resources:
  example:
    type: aws:rds:Cluster
    properties:
      clusterIdentifier: example
      dbSubnetGroupName: ${aws_db_subnet_group.example.name}
      engineMode: multimaster
      masterPassword: barbarbarbar
      masterUsername: foo
      skipFinalSnapshot: true

RDS Multi-AZ Cluster

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()
    {
        AllocatedStorage = 100,
        AvailabilityZones = new[]
        {
            "us-west-2a",
            "us-west-2b",
            "us-west-2c",
        },
        ClusterIdentifier = "example",
        DbClusterInstanceClass = "db.r6gd.xlarge",
        Engine = "mysql",
        Iops = 1000,
        MasterPassword = "mustbeeightcharaters",
        MasterUsername = "test",
        StorageType = "io1",
    });

});

package main

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

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

    }
}

import pulumi
import pulumi_aws as aws

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

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

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

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

RDS Serverless v2 Cluster

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

return await Deployment.RunAsync(() => 
{
    var exampleCluster = new Aws.Rds.Cluster("exampleCluster", new()
    {
        ClusterIdentifier = "example",
        Engine = "aurora-postgresql",
        EngineMode = "provisioned",
        EngineVersion = "13.6",
        DatabaseName = "test",
        MasterUsername = "test",
        MasterPassword = "must_be_eight_characters",
        Serverlessv2ScalingConfiguration = new Aws.Rds.Inputs.ClusterServerlessv2ScalingConfigurationArgs
        {
            MaxCapacity = 1,
            MinCapacity = 0.5,
        },
    });

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

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/rds"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleCluster, err := rds.NewCluster(ctx, "exampleCluster", &rds.ClusterArgs{
			ClusterIdentifier: pulumi.String("example"),
			Engine:            pulumi.String("aurora-postgresql"),
			EngineMode:        pulumi.String("provisioned"),
			EngineVersion:     pulumi.String("13.6"),
			DatabaseName:      pulumi.String("test"),
			MasterUsername:    pulumi.String("test"),
			MasterPassword:    pulumi.String("must_be_eight_characters"),
			Serverlessv2ScalingConfiguration: &rds.ClusterServerlessv2ScalingConfigurationArgs{
				MaxCapacity: pulumi.Float64(1),
				MinCapacity: pulumi.Float64(0.5),
			},
		})
		if err != nil {
			return err
		}
		_, err = rds.NewClusterInstance(ctx, "exampleClusterInstance", &rds.ClusterInstanceArgs{
			ClusterIdentifier: exampleCluster.ID(),
			InstanceClass:     pulumi.String("db.serverless"),
			Engine:            exampleCluster.Engine,
			EngineVersion:     exampleCluster.EngineVersion,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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 exampleCluster = new Cluster("exampleCluster", ClusterArgs.builder()        
            .clusterIdentifier("example")
            .engine("aurora-postgresql")
            .engineMode("provisioned")
            .engineVersion("13.6")
            .databaseName("test")
            .masterUsername("test")
            .masterPassword("must_be_eight_characters")
            .serverlessv2ScalingConfiguration(ClusterServerlessv2ScalingConfigurationArgs.builder()
                .maxCapacity(1)
                .minCapacity(0.5)
                .build())
            .build());

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

    }
}

import pulumi
import pulumi_aws as aws

example_cluster = aws.rds.Cluster("exampleCluster",
    cluster_identifier="example",
    engine="aurora-postgresql",
    engine_mode="provisioned",
    engine_version="13.6",
    database_name="test",
    master_username="test",
    master_password="must_be_eight_characters",
    serverlessv2_scaling_configuration=aws.rds.ClusterServerlessv2ScalingConfigurationArgs(
        max_capacity=1,
        min_capacity=0.5,
    ))
example_cluster_instance = aws.rds.ClusterInstance("exampleClusterInstance",
    cluster_identifier=example_cluster.id,
    instance_class="db.serverless",
    engine=example_cluster.engine,
    engine_version=example_cluster.engine_version)

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

const exampleCluster = new aws.rds.Cluster("exampleCluster", {
    clusterIdentifier: "example",
    engine: "aurora-postgresql",
    engineMode: "provisioned",
    engineVersion: "13.6",
    databaseName: "test",
    masterUsername: "test",
    masterPassword: "must_be_eight_characters",
    serverlessv2ScalingConfiguration: {
        maxCapacity: 1,
        minCapacity: 0.5,
    },
});
const exampleClusterInstance = new aws.rds.ClusterInstance("exampleClusterInstance", {
    clusterIdentifier: exampleCluster.id,
    instanceClass: "db.serverless",
    engine: exampleCluster.engine,
    engineVersion: exampleCluster.engineVersion,
});

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

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

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 main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/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
	})
}

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());

    }
}

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")

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",
});

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

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 main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/kms"
	"github.com/pulumi/pulumi-aws/sdk/v5/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
	})
}

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());

    }
}

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)

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,
});

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

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

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

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

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

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/rds"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleClusterSnapshot, 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, "exampleCluster", &rds.ClusterArgs{
			Engine:             pulumi.String("aurora"),
			EngineVersion:      pulumi.String("5.6.mysql_aurora.1.22.4"),
			ClusterIdentifier:  pulumi.String("example"),
			SnapshotIdentifier: *pulumi.String(exampleClusterSnapshot.Id),
		})
		if err != nil {
			return err
		}
		_, err = rds.NewGlobalCluster(ctx, "exampleGlobalCluster", &rds.GlobalClusterArgs{
			GlobalClusterIdentifier:   pulumi.String("example"),
			SourceDbClusterIdentifier: exampleCluster.Arn,
			ForceDestroy:              pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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 exampleClusterSnapshot = 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(exampleClusterSnapshot.applyValue(getClusterSnapshotResult -> getClusterSnapshotResult.id()))
            .build());

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

    }
}

import pulumi
import pulumi_aws as aws

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

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

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

resources:
  exampleCluster:
    type: aws:rds:Cluster
    properties:
      # Because the global cluster is sourced from this cluster, the initial 
      #   # engine and engine_version values are defined here and automatically
      #   # inherited by the global cluster.
      engine: aurora
      engineVersion: 5.6.mysql_aurora.1.22.4
      clusterIdentifier: example
      snapshotIdentifier: ${exampleClusterSnapshot.id}
  exampleGlobalCluster:
    type: aws:rds:GlobalCluster
    properties:
      globalClusterIdentifier: example
      sourceDbClusterIdentifier: ${exampleCluster.arn}
      forceDestroy: true
variables:
  exampleClusterSnapshot:
    fn::invoke:
      Function: aws:rds:getClusterSnapshot
      Arguments:
        dbClusterIdentifier: example-original-cluster
        mostRecent: true

Create Cluster Resource

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

@overload
def Cluster(resource_name: str,
            opts: Optional[ResourceOptions] = 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,
            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,
            deletion_protection: Optional[bool] = None,
            enable_global_write_forwarding: Optional[bool] = None,
            enable_http_endpoint: Optional[bool] = None,
            enabled_cloudwatch_logs_exports: Optional[Sequence[str]] = None,
            engine: Optional[Union[str, EngineType]] = 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,
            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)
@overload
def Cluster(resource_name: str,
            args: Optional[ClusterArgs] = None,
            opts: Optional[ResourceOptions] = None)

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

public Cluster(string name, ClusterArgs? args = null, 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.

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.

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:

AllocatedStorage int: (Required for Multi-AZ DB cluster) 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 apply. 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: The 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: The days to retain backups for. Default 1
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: (Required for Multi-AZ DB cluster) 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: A DB subnet group to associate with this DB instance. NOTE: This must match the db_subnet_group_name specified on every aws.rds.ClusterInstance in the cluster.
DeletionProtection bool: If the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.
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 Aurora Userguide documentation for more information.
EnableHttpEndpoint bool: Enable HTTP endpoint (data API). Only valid when engine_mode is set to serverless.
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).
Engine string | Pulumi.Aws.Rds.EngineType: The name of the database engine to be used for this DB cluster. Defaults to aurora. Valid Values: aurora, aurora-mysql, aurora-postgresql, mysql, postgres. (Note that mysql and postgres are Multi-AZ RDS clusters).
EngineMode string | Pulumi.Aws.Rds.EngineMode: The database engine mode. Valid values: global (only valid for Aurora MySQL 1.21 and earlier), multimaster, parallelquery, provisioned, serverless. Defaults to: provisioned. See the RDS User Guide for limitations when using serverless.
EngineVersion string: The 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 Attributes Reference below.
FinalSnapshotIdentifier string: The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
GlobalClusterIdentifier string: The 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>: A List of ARNs for the IAM roles to associate to the RDS Cluster.
Iops int: (Required for Multi-AZ DB cluster) The 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. Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
KmsKeyId string: The 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: The 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: The network type of the cluster. Valid values: IPV4, DUAL.
Port int: The port on which the DB accepts connections
PreferredBackupWindow string: The 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 regionE.g., 04:00-09:00
PreferredMaintenanceWindow string: The 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: (Required for Multi-AZ DB clusters) (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 (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

AllocatedStorage int: (Required for Multi-AZ DB cluster) 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 apply. 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: The 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: The days to retain backups for. Default 1
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: (Required for Multi-AZ DB cluster) 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: A DB subnet group to associate with this DB instance. NOTE: This must match the db_subnet_group_name specified on every aws.rds.ClusterInstance in the cluster.
DeletionProtection bool: If the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.
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 Aurora Userguide documentation for more information.
EnableHttpEndpoint bool: Enable HTTP endpoint (data API). Only valid when engine_mode is set to serverless.
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).
Engine string | EngineType: The name of the database engine to be used for this DB cluster. Defaults to aurora. Valid Values: aurora, aurora-mysql, aurora-postgresql, mysql, postgres. (Note that mysql and postgres are Multi-AZ RDS clusters).
EngineMode string | EngineMode: The database engine mode. Valid values: global (only valid for Aurora MySQL 1.21 and earlier), multimaster, parallelquery, provisioned, serverless. Defaults to: provisioned. See the RDS User Guide for limitations when using serverless.
EngineVersion string: The 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 Attributes Reference below.
FinalSnapshotIdentifier string: The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
GlobalClusterIdentifier string: The 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: A List of ARNs for the IAM roles to associate to the RDS Cluster.
Iops int: (Required for Multi-AZ DB cluster) The 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. Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
KmsKeyId string: The 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: The 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: The network type of the cluster. Valid values: IPV4, DUAL.
Port int: The port on which the DB accepts connections
PreferredBackupWindow string: The 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 regionE.g., 04:00-09:00
PreferredMaintenanceWindow string: The 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: (Required for Multi-AZ DB clusters) (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 (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

allocatedStorage Integer: (Required for Multi-AZ DB cluster) 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 apply. 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: The 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: The days to retain backups for. Default 1
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: (Required for Multi-AZ DB cluster) 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: A DB subnet group to associate with this DB instance. NOTE: This must match the db_subnet_group_name specified on every aws.rds.ClusterInstance in the cluster.
deletionProtection Boolean: If the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.
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 Aurora Userguide documentation for more information.
enableHttpEndpoint Boolean: Enable HTTP endpoint (data API). Only valid when engine_mode is set to serverless.
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).
engine String | EngineType: The name of the database engine to be used for this DB cluster. Defaults to aurora. Valid Values: aurora, aurora-mysql, aurora-postgresql, mysql, postgres. (Note that mysql and postgres are Multi-AZ RDS clusters).
engineMode String | EngineMode: The database engine mode. Valid values: global (only valid for Aurora MySQL 1.21 and earlier), multimaster, parallelquery, provisioned, serverless. Defaults to: provisioned. See the RDS User Guide for limitations when using serverless.
engineVersion String: The 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 Attributes Reference below.
finalSnapshotIdentifier String: The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
globalClusterIdentifier String: The 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>: A List of ARNs for the IAM roles to associate to the RDS Cluster.
iops Integer: (Required for Multi-AZ DB cluster) The 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. Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
kmsKeyId String: The 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: The 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: The network type of the cluster. Valid values: IPV4, DUAL.
port Integer: The port on which the DB accepts connections
preferredBackupWindow String: The 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 regionE.g., 04:00-09:00
preferredMaintenanceWindow String: The 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 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: (Required for Multi-AZ DB clusters) (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 (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

allocatedStorage number: (Required for Multi-AZ DB cluster) 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 apply. 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: The 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: The days to retain backups for. Default 1
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: (Required for Multi-AZ DB cluster) 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: A DB subnet group to associate with this DB instance. NOTE: This must match the db_subnet_group_name specified on every aws.rds.ClusterInstance in the cluster.
deletionProtection boolean: If the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.
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 Aurora Userguide documentation for more information.
enableHttpEndpoint boolean: Enable HTTP endpoint (data API). Only valid when engine_mode is set to serverless.
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).
engine string | EngineType: The name of the database engine to be used for this DB cluster. Defaults to aurora. Valid Values: aurora, aurora-mysql, aurora-postgresql, mysql, postgres. (Note that mysql and postgres are Multi-AZ RDS clusters).
engineMode string | EngineMode: The database engine mode. Valid values: global (only valid for Aurora MySQL 1.21 and earlier), multimaster, parallelquery, provisioned, serverless. Defaults to: provisioned. See the RDS User Guide for limitations when using serverless.
engineVersion string: The 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 Attributes Reference below.
finalSnapshotIdentifier string: The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
globalClusterIdentifier string: The 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[]: A List of ARNs for the IAM roles to associate to the RDS Cluster.
iops number: (Required for Multi-AZ DB cluster) The 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. Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
kmsKeyId string: The 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: The 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: The network type of the cluster. Valid values: IPV4, DUAL.
port number: The port on which the DB accepts connections
preferredBackupWindow string: The 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 regionE.g., 04:00-09:00
preferredMaintenanceWindow string: The 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 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: (Required for Multi-AZ DB clusters) (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 (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

allocated_storage int: (Required for Multi-AZ DB cluster) 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 apply. 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: The 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: The days to retain backups for. Default 1
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: (Required for Multi-AZ DB cluster) 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: A DB subnet group to associate with this DB instance. NOTE: This must match the db_subnet_group_name specified on every aws.rds.ClusterInstance in the cluster.
deletion_protection bool: If the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.
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 Aurora Userguide documentation for more information.
enable_http_endpoint bool: Enable HTTP endpoint (data API). Only valid when engine_mode is set to serverless.
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 str | EngineType: The name of the database engine to be used for this DB cluster. Defaults to aurora. Valid Values: aurora, aurora-mysql, aurora-postgresql, mysql, postgres. (Note that mysql and postgres are Multi-AZ RDS clusters).
engine_mode str | EngineMode: The database engine mode. Valid values: global (only valid for Aurora MySQL 1.21 and earlier), multimaster, parallelquery, provisioned, serverless. Defaults to: provisioned. See the RDS User Guide for limitations when using serverless.
engine_version str: The 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 Attributes Reference below.
final_snapshot_identifier str: The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
global_cluster_identifier str: The 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]: A List of ARNs for the IAM roles to associate to the RDS Cluster.
iops int: (Required for Multi-AZ DB cluster) The 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. Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
kms_key_id str: The 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: The 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: The network type of the cluster. Valid values: IPV4, DUAL.
port int: The port on which the DB accepts connections
preferred_backup_window str: The 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 regionE.g., 04:00-09:00
preferred_maintenance_window str: The 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: (Required for Multi-AZ DB clusters) (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 (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

allocatedStorage Number: (Required for Multi-AZ DB cluster) 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 apply. 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: The 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: The days to retain backups for. Default 1
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: (Required for Multi-AZ DB cluster) 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: A DB subnet group to associate with this DB instance. NOTE: This must match the db_subnet_group_name specified on every aws.rds.ClusterInstance in the cluster.
deletionProtection Boolean: If the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.
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 Aurora Userguide documentation for more information.
enableHttpEndpoint Boolean: Enable HTTP endpoint (data API). Only valid when engine_mode is set to serverless.
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).
engine String | "aurora" | "aurora-mysql" | "aurora-postgresql": The name of the database engine to be used for this DB cluster. Defaults to aurora. Valid Values: aurora, aurora-mysql, aurora-postgresql, mysql, postgres. (Note that mysql and postgres are Multi-AZ RDS clusters).
engineMode String | "provisioned" | "serverless" | "parallelquery" | "global": The database engine mode. Valid values: global (only valid for Aurora MySQL 1.21 and earlier), multimaster, parallelquery, provisioned, serverless. Defaults to: provisioned. See the RDS User Guide for limitations when using serverless.
engineVersion String: The 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 Attributes Reference below.
finalSnapshotIdentifier String: The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
globalClusterIdentifier String: The 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>: A List of ARNs for the IAM roles to associate to the RDS Cluster.
iops Number: (Required for Multi-AZ DB cluster) The 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. Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
kmsKeyId String: The 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: The 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: The network type of the cluster. Valid values: IPV4, DUAL.
port Number: The port on which the DB accepts connections
preferredBackupWindow String: The 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 regionE.g., 04:00-09:00
preferredMaintenanceWindow String: The 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: (Required for Multi-AZ DB clusters) (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 (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
ClusterResourceId string: The RDS Cluster Resource ID
Endpoint string: The DNS address of the RDS instance
EngineVersionActual string: The running version of the database.
HostedZoneId string: The Route53 Hosted Zone ID of the endpoint
Id string: The provider-assigned unique ID for this managed resource.
MasterUserSecrets List<ClusterMasterUserSecret>: A block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.
ReaderEndpoint string: A read-only endpoint for the Aurora cluster, automatically load-balanced across replicas
TagsAll Dictionary<string, string>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Arn string: Amazon Resource Name (ARN) of cluster
ClusterResourceId string: The RDS Cluster Resource ID
Endpoint string: The DNS address of the RDS instance
EngineVersionActual string: The running version of the database.
HostedZoneId string: The Route53 Hosted Zone ID of the endpoint
Id string: The provider-assigned unique ID for this managed resource.
MasterUserSecrets []ClusterMasterUserSecret: A block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.
ReaderEndpoint string: A read-only endpoint for the Aurora cluster, automatically load-balanced across replicas
TagsAll map[string]string: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String: Amazon Resource Name (ARN) of cluster
clusterResourceId String: The RDS Cluster Resource ID
endpoint String: The DNS address of the RDS instance
engineVersionActual String: The running version of the database.
hostedZoneId String: The Route53 Hosted Zone ID of the endpoint
id String: The provider-assigned unique ID for this managed resource.
masterUserSecrets List<ClusterMasterUserSecret>: A block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.
readerEndpoint String: A read-only endpoint for the Aurora cluster, automatically load-balanced across replicas
tagsAll Map<String,String>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn string: Amazon Resource Name (ARN) of cluster
clusterResourceId string: The RDS Cluster Resource ID
endpoint string: The DNS address of the RDS instance
engineVersionActual string: The running version of the database.
hostedZoneId string: The Route53 Hosted Zone ID of the endpoint
id string: The provider-assigned unique ID for this managed resource.
masterUserSecrets ClusterMasterUserSecret[]: A block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.
readerEndpoint string: A read-only endpoint for the Aurora cluster, automatically load-balanced across replicas
tagsAll {[key: string]: string}: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn str: Amazon Resource Name (ARN) of cluster
cluster_resource_id str: The RDS Cluster Resource ID
endpoint str: The DNS address of the RDS instance
engine_version_actual str: The running version of the database.
hosted_zone_id str: The Route53 Hosted Zone ID of the endpoint
id str: The provider-assigned unique ID for this managed resource.
master_user_secrets Sequence[ClusterMasterUserSecret]: A block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.
reader_endpoint str: A read-only endpoint for the Aurora cluster, automatically load-balanced across replicas
tags_all Mapping[str, str]: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String: Amazon Resource Name (ARN) of cluster
clusterResourceId String: The RDS Cluster Resource ID
endpoint String: The DNS address of the RDS instance
engineVersionActual String: The running version of the database.
hostedZoneId String: The Route53 Hosted Zone ID of the endpoint
id String: The provider-assigned unique ID for this managed resource.
masterUserSecrets List<Property Map>: A block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.
readerEndpoint String: A read-only endpoint for the Aurora cluster, automatically load-balanced across replicas
tagsAll Map<String>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

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,
        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,
        deletion_protection: Optional[bool] = None,
        enable_global_write_forwarding: Optional[bool] = None,
        enable_http_endpoint: Optional[bool] = None,
        enabled_cloudwatch_logs_exports: Optional[Sequence[str]] = None,
        endpoint: Optional[str] = None,
        engine: Optional[Union[str, EngineType]] = 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,
        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: (Required for Multi-AZ DB cluster) 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 apply. 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: The 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: The days to retain backups for. Default 1
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: The 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: (Required for Multi-AZ DB cluster) 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: A DB subnet group to associate with this DB instance. NOTE: This must match the db_subnet_group_name specified on every aws.rds.ClusterInstance in the cluster.
DeletionProtection bool: If the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.
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 Aurora Userguide documentation for more information.
EnableHttpEndpoint bool: Enable HTTP endpoint (data API). Only valid when engine_mode is set to serverless.
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: The DNS address of the RDS instance
Engine string | Pulumi.Aws.Rds.EngineType: The name of the database engine to be used for this DB cluster. Defaults to aurora. Valid Values: aurora, aurora-mysql, aurora-postgresql, mysql, postgres. (Note that mysql and postgres are Multi-AZ RDS clusters).
EngineMode string | Pulumi.Aws.Rds.EngineMode: The database engine mode. Valid values: global (only valid for Aurora MySQL 1.21 and earlier), multimaster, parallelquery, provisioned, serverless. Defaults to: provisioned. See the RDS User Guide for limitations when using serverless.
EngineVersion string: The 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 Attributes Reference below.
EngineVersionActual string: The running version of the database.
FinalSnapshotIdentifier string: The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
GlobalClusterIdentifier string: The global cluster identifier specified on aws.rds.GlobalCluster.
HostedZoneId string: The 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>: A List of ARNs for the IAM roles to associate to the RDS Cluster.
Iops int: (Required for Multi-AZ DB cluster) The 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. Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
KmsKeyId string: The 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: The 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<ClusterMasterUserSecretArgs>: A 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: The network type of the cluster. Valid values: IPV4, DUAL.
Port int: The port on which the DB accepts connections
PreferredBackupWindow string: The 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 regionE.g., 04:00-09:00
PreferredMaintenanceWindow string: The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
ReaderEndpoint string: A 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: (Required for Multi-AZ DB clusters) (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 (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>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
VpcSecurityGroupIds List<string>: List of VPC security groups to associate with the Cluster

AllocatedStorage int: (Required for Multi-AZ DB cluster) 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 apply. 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: The 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: The days to retain backups for. Default 1
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: The 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: (Required for Multi-AZ DB cluster) 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: A DB subnet group to associate with this DB instance. NOTE: This must match the db_subnet_group_name specified on every aws.rds.ClusterInstance in the cluster.
DeletionProtection bool: If the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.
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 Aurora Userguide documentation for more information.
EnableHttpEndpoint bool: Enable HTTP endpoint (data API). Only valid when engine_mode is set to serverless.
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: The DNS address of the RDS instance
Engine string | EngineType: The name of the database engine to be used for this DB cluster. Defaults to aurora. Valid Values: aurora, aurora-mysql, aurora-postgresql, mysql, postgres. (Note that mysql and postgres are Multi-AZ RDS clusters).
EngineMode string | EngineMode: The database engine mode. Valid values: global (only valid for Aurora MySQL 1.21 and earlier), multimaster, parallelquery, provisioned, serverless. Defaults to: provisioned. See the RDS User Guide for limitations when using serverless.
EngineVersion string: The 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 Attributes Reference below.
EngineVersionActual string: The running version of the database.
FinalSnapshotIdentifier string: The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
GlobalClusterIdentifier string: The global cluster identifier specified on aws.rds.GlobalCluster.
HostedZoneId string: The 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: A List of ARNs for the IAM roles to associate to the RDS Cluster.
Iops int: (Required for Multi-AZ DB cluster) The 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. Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
KmsKeyId string: The 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: The 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: A 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: The network type of the cluster. Valid values: IPV4, DUAL.
Port int: The port on which the DB accepts connections
PreferredBackupWindow string: The 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 regionE.g., 04:00-09:00
PreferredMaintenanceWindow string: The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
ReaderEndpoint string: A 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: (Required for Multi-AZ DB clusters) (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 (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: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
VpcSecurityGroupIds []string: List of VPC security groups to associate with the Cluster

allocatedStorage Integer: (Required for Multi-AZ DB cluster) 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 apply. 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: The 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: The days to retain backups for. Default 1
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: The 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: (Required for Multi-AZ DB cluster) 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: A DB subnet group to associate with this DB instance. NOTE: This must match the db_subnet_group_name specified on every aws.rds.ClusterInstance in the cluster.
deletionProtection Boolean: If the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.
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 Aurora Userguide documentation for more information.
enableHttpEndpoint Boolean: Enable HTTP endpoint (data API). Only valid when engine_mode is set to serverless.
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: The DNS address of the RDS instance
engine String | EngineType: The name of the database engine to be used for this DB cluster. Defaults to aurora. Valid Values: aurora, aurora-mysql, aurora-postgresql, mysql, postgres. (Note that mysql and postgres are Multi-AZ RDS clusters).
engineMode String | EngineMode: The database engine mode. Valid values: global (only valid for Aurora MySQL 1.21 and earlier), multimaster, parallelquery, provisioned, serverless. Defaults to: provisioned. See the RDS User Guide for limitations when using serverless.
engineVersion String: The 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 Attributes Reference below.
engineVersionActual String: The running version of the database.
finalSnapshotIdentifier String: The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
globalClusterIdentifier String: The global cluster identifier specified on aws.rds.GlobalCluster.
hostedZoneId String: The 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>: A List of ARNs for the IAM roles to associate to the RDS Cluster.
iops Integer: (Required for Multi-AZ DB cluster) The 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. Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
kmsKeyId String: The 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: The 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<ClusterMasterUserSecretArgs>: A 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: The network type of the cluster. Valid values: IPV4, DUAL.
port Integer: The port on which the DB accepts connections
preferredBackupWindow String: The 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 regionE.g., 04:00-09:00
preferredMaintenanceWindow String: The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
readerEndpoint String: A 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 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: (Required for Multi-AZ DB clusters) (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 (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>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
vpcSecurityGroupIds List<String>: List of VPC security groups to associate with the Cluster

allocatedStorage number: (Required for Multi-AZ DB cluster) 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 apply. 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: The 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: The days to retain backups for. Default 1
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: The 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: (Required for Multi-AZ DB cluster) 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: A DB subnet group to associate with this DB instance. NOTE: This must match the db_subnet_group_name specified on every aws.rds.ClusterInstance in the cluster.
deletionProtection boolean: If the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.
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 Aurora Userguide documentation for more information.
enableHttpEndpoint boolean: Enable HTTP endpoint (data API). Only valid when engine_mode is set to serverless.
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: The DNS address of the RDS instance
engine string | EngineType: The name of the database engine to be used for this DB cluster. Defaults to aurora. Valid Values: aurora, aurora-mysql, aurora-postgresql, mysql, postgres. (Note that mysql and postgres are Multi-AZ RDS clusters).
engineMode string | EngineMode: The database engine mode. Valid values: global (only valid for Aurora MySQL 1.21 and earlier), multimaster, parallelquery, provisioned, serverless. Defaults to: provisioned. See the RDS User Guide for limitations when using serverless.
engineVersion string: The 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 Attributes Reference below.
engineVersionActual string: The running version of the database.
finalSnapshotIdentifier string: The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
globalClusterIdentifier string: The global cluster identifier specified on aws.rds.GlobalCluster.
hostedZoneId string: The 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[]: A List of ARNs for the IAM roles to associate to the RDS Cluster.
iops number: (Required for Multi-AZ DB cluster) The 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. Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
kmsKeyId string: The 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: The 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[]: A 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: The network type of the cluster. Valid values: IPV4, DUAL.
port number: The port on which the DB accepts connections
preferredBackupWindow string: The 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 regionE.g., 04:00-09:00
preferredMaintenanceWindow string: The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
readerEndpoint string: A 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 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: (Required for Multi-AZ DB clusters) (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 (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}: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
vpcSecurityGroupIds string[]: List of VPC security groups to associate with the Cluster

allocated_storage int: (Required for Multi-AZ DB cluster) 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 apply. 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: The 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: The days to retain backups for. Default 1
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: The 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: (Required for Multi-AZ DB cluster) 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: A DB subnet group to associate with this DB instance. NOTE: This must match the db_subnet_group_name specified on every aws.rds.ClusterInstance in the cluster.
deletion_protection bool: If the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.
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 Aurora Userguide documentation for more information.
enable_http_endpoint bool: Enable HTTP endpoint (data API). Only valid when engine_mode is set to serverless.
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: The DNS address of the RDS instance
engine str | EngineType: The name of the database engine to be used for this DB cluster. Defaults to aurora. Valid Values: aurora, aurora-mysql, aurora-postgresql, mysql, postgres. (Note that mysql and postgres are Multi-AZ RDS clusters).
engine_mode str | EngineMode: The database engine mode. Valid values: global (only valid for Aurora MySQL 1.21 and earlier), multimaster, parallelquery, provisioned, serverless. Defaults to: provisioned. See the RDS User Guide for limitations when using serverless.
engine_version str: The 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 Attributes Reference below.
engine_version_actual str: The running version of the database.
final_snapshot_identifier str: The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
global_cluster_identifier str: The global cluster identifier specified on aws.rds.GlobalCluster.
hosted_zone_id str: The 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]: A List of ARNs for the IAM roles to associate to the RDS Cluster.
iops int: (Required for Multi-AZ DB cluster) The 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. Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
kms_key_id str: The 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: The 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]: A 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: The network type of the cluster. Valid values: IPV4, DUAL.
port int: The port on which the DB accepts connections
preferred_backup_window str: The 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 regionE.g., 04:00-09:00
preferred_maintenance_window str: The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
reader_endpoint str: A 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: (Required for Multi-AZ DB clusters) (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 (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]: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
vpc_security_group_ids Sequence[str]: List of VPC security groups to associate with the Cluster

allocatedStorage Number: (Required for Multi-AZ DB cluster) 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 apply. 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: The 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: The days to retain backups for. Default 1
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: The 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: (Required for Multi-AZ DB cluster) 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: A DB subnet group to associate with this DB instance. NOTE: This must match the db_subnet_group_name specified on every aws.rds.ClusterInstance in the cluster.
deletionProtection Boolean: If the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.
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 Aurora Userguide documentation for more information.
enableHttpEndpoint Boolean: Enable HTTP endpoint (data API). Only valid when engine_mode is set to serverless.
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: The DNS address of the RDS instance
engine String | "aurora" | "aurora-mysql" | "aurora-postgresql": The name of the database engine to be used for this DB cluster. Defaults to aurora. Valid Values: aurora, aurora-mysql, aurora-postgresql, mysql, postgres. (Note that mysql and postgres are Multi-AZ RDS clusters).
engineMode String | "provisioned" | "serverless" | "parallelquery" | "global": The database engine mode. Valid values: global (only valid for Aurora MySQL 1.21 and earlier), multimaster, parallelquery, provisioned, serverless. Defaults to: provisioned. See the RDS User Guide for limitations when using serverless.
engineVersion String: The 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 Attributes Reference below.
engineVersionActual String: The running version of the database.
finalSnapshotIdentifier String: The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
globalClusterIdentifier String: The global cluster identifier specified on aws.rds.GlobalCluster.
hostedZoneId String: The 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>: A List of ARNs for the IAM roles to associate to the RDS Cluster.
iops Number: (Required for Multi-AZ DB cluster) The 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. Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
kmsKeyId String: The 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: The 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>: A 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: The network type of the cluster. Valid values: IPV4, DUAL.
port Number: The port on which the DB accepts connections
preferredBackupWindow String: The 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 regionE.g., 04:00-09:00
preferredMaintenanceWindow String: The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30
readerEndpoint String: A 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: (Required for Multi-AZ DB clusters) (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 (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>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
vpcSecurityGroupIds List<String>: List of VPC security groups to associate with the Cluster

Supporting Types

ClusterMasterUserSecret

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

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

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

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

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

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

ClusterRestoreToPointInTime

SourceClusterIdentifier string: The identifier of the source database cluster from which to restore.
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.
UseLatestRestorableTime bool: Set to true to restore the database cluster to the latest restorable backup time. Defaults to false. Conflicts with restore_to_time.

SourceClusterIdentifier string: The identifier of the source database cluster from which to restore.
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.
UseLatestRestorableTime bool: Set to true to restore the database cluster to the latest restorable backup time. Defaults to false. Conflicts with restore_to_time.

sourceClusterIdentifier String: The identifier of the source database cluster from which to restore.
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.
useLatestRestorableTime Boolean: Set to true to restore the database cluster to the latest restorable backup time. Defaults to false. Conflicts with restore_to_time.

sourceClusterIdentifier string: The identifier of the source database cluster from which to restore.
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.
useLatestRestorableTime boolean: Set to true to restore the database cluster to the latest restorable backup time. Defaults to false. Conflicts with restore_to_time.

source_cluster_identifier str: The identifier of the source database cluster from which to restore.
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.
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.

sourceClusterIdentifier String: The identifier of the source database cluster from which to restore.
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.
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

BucketName string: The 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: The 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: The 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: The 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: The 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: The 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

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: The 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: The 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.
SecondsUntilAutoPause int: The time, in seconds, before an Aurora DB cluster in serverless mode is paused. Valid values are 300 through 86400. Defaults to 300.
TimeoutAction string: The 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: The 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: The 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.
SecondsUntilAutoPause int: The time, in seconds, before an Aurora DB cluster in serverless mode is paused. Valid values are 300 through 86400. Defaults to 300.
TimeoutAction string: The 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: The 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: The 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.
secondsUntilAutoPause Integer: The time, in seconds, before an Aurora DB cluster in serverless mode is paused. Valid values are 300 through 86400. Defaults to 300.
timeoutAction String: The 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: The 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: The 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.
secondsUntilAutoPause number: The time, in seconds, before an Aurora DB cluster in serverless mode is paused. Valid values are 300 through 86400. Defaults to 300.
timeoutAction string: The 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: The 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: The 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_until_auto_pause int: The 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: The 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: The 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: The 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.
secondsUntilAutoPause Number: The time, in seconds, before an Aurora DB cluster in serverless mode is paused. Valid values are 300 through 86400. Defaults to 300.
timeoutAction String: The action to take when the timeout is reached. Valid values: ForceApplyCapacityChange, RollbackCapacityChange. Defaults to RollbackCapacityChange. See documentation.

ClusterServerlessv2ScalingConfiguration

MaxCapacity double: The 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 double: The 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.

MaxCapacity float64: The 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 float64: The 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.

maxCapacity Double: The 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 Double: The 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.

maxCapacity number: The 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: The 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.

max_capacity float: The 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 float: The 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.

maxCapacity Number: The 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: The 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.

EngineMode

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

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

RDS Clusters can be imported using the cluster_identifier, e.g.,

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

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.