Instance

AWS v5.43.0 (5.x), Mar 10 26

Viewing docs for AWS v5.43.0 (Older version)
published on Tuesday, Mar 10, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-aws

Viewing docs for AWS v5.43.0 (Older version)
published on Tuesday, Mar 10, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-aws

Changes to a DB instance can occur when you manually change a parameter, such as allocated_storage, 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).

When upgrading the major version of an engine, allow_major_version_upgrade must be set to true.

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

Note: All arguments including the username and password will be stored in the raw state as plain-text. Read more about sensitive data instate.

RDS Instance Class Types

Amazon RDS supports three types of instance classes: Standard, Memory Optimized, and Burstable Performance. For more information please read the AWS RDS documentation about DB Instance Class Types

Low-Downtime Updates

By default, RDS applies updates to DB Instances in-place, which can lead to service interruptions. Low-downtime updates minimize service interruptions by performing the updates with an [RDS Blue/Green deployment][blue-green] and switching over the instances when complete.

Low-downtime updates are only available for DB Instances using MySQL and MariaDB, as other engines are not supported by RDS Blue/Green deployments.

Backups must be enabled to use low-downtime updates.

Enable low-downtime updates by setting blue_green_update.enabled to true.

Example Usage

Basic Usage

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

return await Deployment.RunAsync(() => 
{
    var @default = new Aws.Rds.Instance("default", new()
    {
        AllocatedStorage = 10,
        DbName = "mydb",
        Engine = "mysql",
        EngineVersion = "5.7",
        InstanceClass = "db.t3.micro",
        ParameterGroupName = "default.mysql5.7",
        Password = "foobarbaz",
        SkipFinalSnapshot = true,
        Username = "foo",
    });

});

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.NewInstance(ctx, "default", &rds.InstanceArgs{
			AllocatedStorage:   pulumi.Int(10),
			DbName:             pulumi.String("mydb"),
			Engine:             pulumi.String("mysql"),
			EngineVersion:      pulumi.String("5.7"),
			InstanceClass:      pulumi.String("db.t3.micro"),
			ParameterGroupName: pulumi.String("default.mysql5.7"),
			Password:           pulumi.String("foobarbaz"),
			SkipFinalSnapshot:  pulumi.Bool(true),
			Username:           pulumi.String("foo"),
		})
		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.Instance;
import com.pulumi.aws.rds.InstanceArgs;
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 Instance("default", InstanceArgs.builder()        
            .allocatedStorage(10)
            .dbName("mydb")
            .engine("mysql")
            .engineVersion("5.7")
            .instanceClass("db.t3.micro")
            .parameterGroupName("default.mysql5.7")
            .password("foobarbaz")
            .skipFinalSnapshot(true)
            .username("foo")
            .build());

    }
}

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

const _default = new aws.rds.Instance("default", {
    allocatedStorage: 10,
    dbName: "mydb",
    engine: "mysql",
    engineVersion: "5.7",
    instanceClass: "db.t3.micro",
    parameterGroupName: "default.mysql5.7",
    password: "foobarbaz",
    skipFinalSnapshot: true,
    username: "foo",
});

import pulumi
import pulumi_aws as aws

default = aws.rds.Instance("default",
    allocated_storage=10,
    db_name="mydb",
    engine="mysql",
    engine_version="5.7",
    instance_class="db.t3.micro",
    parameter_group_name="default.mysql5.7",
    password="foobarbaz",
    skip_final_snapshot=True,
    username="foo")

resources:
  default:
    type: aws:rds:Instance
    properties:
      allocatedStorage: 10
      dbName: mydb
      engine: mysql
      engineVersion: '5.7'
      instanceClass: db.t3.micro
      parameterGroupName: default.mysql5.7
      password: foobarbaz
      skipFinalSnapshot: true
      username: foo

RDS Custom for Oracle Usage with Replica

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

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Rds.Instance("example", new()
    {
        AllocatedStorage = 50,
        MaxAllocatedStorage = 100,
    });

});

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.NewInstance(ctx, "example", &rds.InstanceArgs{
			AllocatedStorage:    pulumi.Int(50),
			MaxAllocatedStorage: pulumi.Int(100),
		})
		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.GetOrderableDbInstanceArgs;
import com.pulumi.aws.kms.KmsFunctions;
import com.pulumi.aws.kms.inputs.GetKeyArgs;
import com.pulumi.aws.rds.Instance;
import com.pulumi.aws.rds.InstanceArgs;
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 custom-oracle = RdsFunctions.getOrderableDbInstance(GetOrderableDbInstanceArgs.builder()
            .engine("custom-oracle-ee")
            .engineVersion("19.c.ee.002")
            .licenseModel("bring-your-own-license")
            .storageType("gp3")
            .preferredInstanceClasses(            
                "db.r5.24xlarge",
                "db.r5.16xlarge",
                "db.r5.12xlarge")
            .build());

        final var byId = KmsFunctions.getKey(GetKeyArgs.builder()
            .keyId("example-ef278353ceba4a5a97de6784565b9f78")
            .build());

        var default_ = new Instance("default", InstanceArgs.builder()        
            .allocatedStorage(50)
            .autoMinorVersionUpgrade(false)
            .customIamInstanceProfile("AWSRDSCustomInstanceProfile")
            .backupRetentionPeriod(7)
            .dbSubnetGroupName(local.db_subnet_group_name())
            .engine(custom_oracle.engine())
            .engineVersion(custom_oracle.engineVersion())
            .identifier("ee-instance-demo")
            .instanceClass(custom_oracle.instanceClass())
            .kmsKeyId(byId.applyValue(getKeyResult -> getKeyResult.arn()))
            .licenseModel(custom_oracle.licenseModel())
            .multiAz(false)
            .password("avoid-plaintext-passwords")
            .username("test")
            .storageEncrypted(true)
            .timeouts(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
            .build());

        var test_replica = new Instance("test-replica", InstanceArgs.builder()        
            .replicateSourceDb(default_.identifier())
            .replicaMode("mounted")
            .autoMinorVersionUpgrade(false)
            .customIamInstanceProfile("AWSRDSCustomInstanceProfile")
            .backupRetentionPeriod(7)
            .identifier("ee-instance-replica")
            .instanceClass(custom_oracle.instanceClass())
            .kmsKeyId(byId.applyValue(getKeyResult -> getKeyResult.arn()))
            .multiAz(false)
            .skipFinalSnapshot(true)
            .storageEncrypted(true)
            .timeouts(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
            .build());

    }
}

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

const example = new aws.rds.Instance("example", {
    allocatedStorage: 50,
    maxAllocatedStorage: 100,
});

import pulumi
import pulumi_aws as aws

example = aws.rds.Instance("example",
    allocated_storage=50,
    max_allocated_storage=100)

resources:
  default:
    type: aws:rds:Instance
    properties:
      allocatedStorage: 50
      autoMinorVersionUpgrade: false
      # Custom for Oracle not support minor version upgrades
      customIamInstanceProfile: AWSRDSCustomInstanceProfile
      # Instance profile is required for Custom for Oracle. See: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
      backupRetentionPeriod: 7
      dbSubnetGroupName: ${local.db_subnet_group_name}
      engine: ${["custom-oracle"].engine}
      engineVersion: ${["custom-oracle"].engineVersion}
      identifier: ee-instance-demo
      instanceClass: ${["custom-oracle"].instanceClass}
      kmsKeyId: ${byId.arn}
      licenseModel: ${["custom-oracle"].licenseModel}
      multiAz: false
      # Custom for Oracle does not support multi-az
      password: avoid-plaintext-passwords
      username: test
      storageEncrypted: true
      timeouts:
        - create: 3h
          delete: 3h
          update: 3h
  test-replica:
    type: aws:rds:Instance
    properties:
      replicateSourceDb: ${default.identifier}
      replicaMode: mounted
      autoMinorVersionUpgrade: false
      customIamInstanceProfile: AWSRDSCustomInstanceProfile
      # Instance profile is required for Custom for Oracle. See: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
      backupRetentionPeriod: 7
      identifier: ee-instance-replica
      instanceClass: ${["custom-oracle"].instanceClass}
      kmsKeyId: ${byId.arn}
      multiAz: false
      # Custom for Oracle does not support multi-az
      skipFinalSnapshot: true
      storageEncrypted: true
      timeouts:
        - create: 3h
          delete: 3h
          update: 3h
variables:
  custom-oracle:
    fn::invoke:
      Function: aws:rds:getOrderableDbInstance
      Arguments:
        engine: custom-oracle-ee
        engineVersion: 19.c.ee.002
        licenseModel: bring-your-own-license
        storageType: gp3
        preferredInstanceClasses:
          - db.r5.24xlarge
          - db.r5.16xlarge
          - db.r5.12xlarge
  byId:
    fn::invoke:
      Function: aws:kms:getKey
      Arguments:
        keyId: example-ef278353ceba4a5a97de6784565b9f78

Storage Autoscaling

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

return await Deployment.RunAsync(() => 
{
    var @default = new Aws.Rds.Instance("default", new()
    {
        AllocatedStorage = 10,
        DbName = "mydb",
        Engine = "mysql",
        EngineVersion = "5.7",
        InstanceClass = "db.t3.micro",
        ManageMasterUserPassword = true,
        ParameterGroupName = "default.mysql5.7",
        Username = "foo",
    });

});

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.NewInstance(ctx, "default", &rds.InstanceArgs{
			AllocatedStorage:         pulumi.Int(10),
			DbName:                   pulumi.String("mydb"),
			Engine:                   pulumi.String("mysql"),
			EngineVersion:            pulumi.String("5.7"),
			InstanceClass:            pulumi.String("db.t3.micro"),
			ManageMasterUserPassword: pulumi.Bool(true),
			ParameterGroupName:       pulumi.String("default.mysql5.7"),
			Username:                 pulumi.String("foo"),
		})
		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.Instance;
import com.pulumi.aws.rds.InstanceArgs;
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 Instance("example", InstanceArgs.builder()        
            .allocatedStorage(50)
            .maxAllocatedStorage(100)
            .build());

    }
}

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

const _default = new aws.rds.Instance("default", {
    allocatedStorage: 10,
    dbName: "mydb",
    engine: "mysql",
    engineVersion: "5.7",
    instanceClass: "db.t3.micro",
    manageMasterUserPassword: true,
    parameterGroupName: "default.mysql5.7",
    username: "foo",
});

import pulumi
import pulumi_aws as aws

default = aws.rds.Instance("default",
    allocated_storage=10,
    db_name="mydb",
    engine="mysql",
    engine_version="5.7",
    instance_class="db.t3.micro",
    manage_master_user_password=True,
    parameter_group_name="default.mysql5.7",
    username="foo")

resources:
  example:
    type: aws:rds:Instance
    properties:
      allocatedStorage: 50
      maxAllocatedStorage: 100

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 example = new Aws.Kms.Key("example", new()
    {
        Description = "Example KMS Key",
    });

    var @default = new Aws.Rds.Instance("default", new()
    {
        AllocatedStorage = 10,
        DbName = "mydb",
        Engine = "mysql",
        EngineVersion = "5.7",
        InstanceClass = "db.t3.micro",
        ManageMasterUserPassword = true,
        MasterUserSecretKmsKeyId = example.KeyId,
        Username = "foo",
        ParameterGroupName = "default.mysql5.7",
    });

});

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.NewInstance(ctx, "default", &rds.InstanceArgs{
			AllocatedStorage:         pulumi.Int(10),
			DbName:                   pulumi.String("mydb"),
			Engine:                   pulumi.String("mysql"),
			EngineVersion:            pulumi.String("5.7"),
			InstanceClass:            pulumi.String("db.t3.micro"),
			ManageMasterUserPassword: pulumi.Bool(true),
			MasterUserSecretKmsKeyId: example.KeyId,
			Username:                 pulumi.String("foo"),
			ParameterGroupName:       pulumi.String("default.mysql5.7"),
		})
		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.Instance;
import com.pulumi.aws.rds.InstanceArgs;
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 Instance("default", InstanceArgs.builder()        
            .allocatedStorage(10)
            .dbName("mydb")
            .engine("mysql")
            .engineVersion("5.7")
            .instanceClass("db.t3.micro")
            .manageMasterUserPassword(true)
            .parameterGroupName("default.mysql5.7")
            .username("foo")
            .build());

    }
}

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

const example = new aws.kms.Key("example", {description: "Example KMS Key"});
const _default = new aws.rds.Instance("default", {
    allocatedStorage: 10,
    dbName: "mydb",
    engine: "mysql",
    engineVersion: "5.7",
    instanceClass: "db.t3.micro",
    manageMasterUserPassword: true,
    masterUserSecretKmsKeyId: example.keyId,
    username: "foo",
    parameterGroupName: "default.mysql5.7",
});

import pulumi
import pulumi_aws as aws

example = aws.kms.Key("example", description="Example KMS Key")
default = aws.rds.Instance("default",
    allocated_storage=10,
    db_name="mydb",
    engine="mysql",
    engine_version="5.7",
    instance_class="db.t3.micro",
    manage_master_user_password=True,
    master_user_secret_kms_key_id=example.key_id,
    username="foo",
    parameter_group_name="default.mysql5.7")

resources:
  default:
    type: aws:rds:Instance
    properties:
      allocatedStorage: 10
      dbName: mydb
      engine: mysql
      engineVersion: '5.7'
      instanceClass: db.t3.micro
      manageMasterUserPassword: true
      parameterGroupName: default.mysql5.7
      username: foo

Managed Master Passwords via Secrets Manager, specific KMS Key

Example coming soon!

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.Instance;
import com.pulumi.aws.rds.InstanceArgs;
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 default_ = new Instance("default", InstanceArgs.builder()        
            .allocatedStorage(10)
            .dbName("mydb")
            .engine("mysql")
            .engineVersion("5.7")
            .instanceClass("db.t3.micro")
            .manageMasterUserPassword(true)
            .masterUserSecretKmsKeyId(example.keyId())
            .username("foo")
            .parameterGroupName("default.mysql5.7")
            .build());

    }
}

Example coming soon!

resources:
  example:
    type: aws:kms:Key
    properties:
      description: Example KMS Key
  default:
    type: aws:rds:Instance
    properties:
      allocatedStorage: 10
      dbName: mydb
      engine: mysql
      engineVersion: '5.7'
      instanceClass: db.t3.micro
      manageMasterUserPassword: true
      masterUserSecretKmsKeyId: ${example.keyId}
      username: foo
      parameterGroupName: default.mysql5.7

Create Instance Resource

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

Constructor syntax

new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);

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

@overload
def Instance(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             instance_class: Optional[Union[str, InstanceType]] = None,
             allocated_storage: Optional[int] = None,
             allow_major_version_upgrade: Optional[bool] = None,
             apply_immediately: Optional[bool] = None,
             auto_minor_version_upgrade: Optional[bool] = None,
             availability_zone: Optional[str] = None,
             backup_retention_period: Optional[int] = None,
             backup_window: Optional[str] = None,
             blue_green_update: Optional[InstanceBlueGreenUpdateArgs] = None,
             ca_cert_identifier: Optional[str] = None,
             character_set_name: Optional[str] = None,
             copy_tags_to_snapshot: Optional[bool] = None,
             custom_iam_instance_profile: Optional[str] = None,
             customer_owned_ip_enabled: Optional[bool] = None,
             db_name: Optional[str] = None,
             db_subnet_group_name: Optional[str] = None,
             delete_automated_backups: Optional[bool] = None,
             deletion_protection: Optional[bool] = None,
             domain: Optional[str] = None,
             domain_iam_role_name: Optional[str] = None,
             enabled_cloudwatch_logs_exports: Optional[Sequence[str]] = None,
             engine: Optional[str] = None,
             engine_version: Optional[str] = None,
             final_snapshot_identifier: Optional[str] = None,
             iam_database_authentication_enabled: Optional[bool] = None,
             identifier: Optional[str] = None,
             identifier_prefix: Optional[str] = None,
             iops: Optional[int] = None,
             kms_key_id: Optional[str] = None,
             license_model: Optional[str] = None,
             maintenance_window: Optional[str] = None,
             manage_master_user_password: Optional[bool] = None,
             master_user_secret_kms_key_id: Optional[str] = None,
             max_allocated_storage: Optional[int] = None,
             monitoring_interval: Optional[int] = None,
             monitoring_role_arn: Optional[str] = None,
             multi_az: Optional[bool] = None,
             name: Optional[str] = None,
             nchar_character_set_name: Optional[str] = None,
             network_type: Optional[str] = None,
             option_group_name: Optional[str] = None,
             parameter_group_name: Optional[str] = None,
             password: Optional[str] = None,
             performance_insights_enabled: Optional[bool] = None,
             performance_insights_kms_key_id: Optional[str] = None,
             performance_insights_retention_period: Optional[int] = None,
             port: Optional[int] = None,
             publicly_accessible: Optional[bool] = None,
             replica_mode: Optional[str] = None,
             replicate_source_db: Optional[str] = None,
             restore_to_point_in_time: Optional[InstanceRestoreToPointInTimeArgs] = None,
             s3_import: Optional[InstanceS3ImportArgs] = None,
             security_group_names: Optional[Sequence[str]] = None,
             skip_final_snapshot: Optional[bool] = None,
             snapshot_identifier: Optional[str] = None,
             storage_encrypted: Optional[bool] = None,
             storage_throughput: Optional[int] = None,
             storage_type: Optional[Union[str, StorageType]] = None,
             tags: Optional[Mapping[str, str]] = None,
             timezone: Optional[str] = None,
             username: Optional[str] = None,
             vpc_security_group_ids: Optional[Sequence[str]] = None)

func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)

public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)

public Instance(String name, InstanceArgs args)
public Instance(String name, InstanceArgs args, CustomResourceOptions options)

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

Parameters

name string: The unique name of the resource.
args InstanceArgs: 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 InstanceArgs: 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 InstanceArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args InstanceArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

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

var exampleinstanceResourceResourceFromRdsinstance = new Aws.Rds.Instance("exampleinstanceResourceResourceFromRdsinstance", new()
{
    InstanceClass = "string",
    AllocatedStorage = 0,
    AllowMajorVersionUpgrade = false,
    ApplyImmediately = false,
    AutoMinorVersionUpgrade = false,
    AvailabilityZone = "string",
    BackupRetentionPeriod = 0,
    BackupWindow = "string",
    BlueGreenUpdate = new Aws.Rds.Inputs.InstanceBlueGreenUpdateArgs
    {
        Enabled = false,
    },
    CaCertIdentifier = "string",
    CharacterSetName = "string",
    CopyTagsToSnapshot = false,
    CustomIamInstanceProfile = "string",
    CustomerOwnedIpEnabled = false,
    DbName = "string",
    DbSubnetGroupName = "string",
    DeleteAutomatedBackups = false,
    DeletionProtection = false,
    Domain = "string",
    DomainIamRoleName = "string",
    EnabledCloudwatchLogsExports = new[]
    {
        "string",
    },
    Engine = "string",
    EngineVersion = "string",
    FinalSnapshotIdentifier = "string",
    IamDatabaseAuthenticationEnabled = false,
    Identifier = "string",
    IdentifierPrefix = "string",
    Iops = 0,
    KmsKeyId = "string",
    LicenseModel = "string",
    MaintenanceWindow = "string",
    ManageMasterUserPassword = false,
    MasterUserSecretKmsKeyId = "string",
    MaxAllocatedStorage = 0,
    MonitoringInterval = 0,
    MonitoringRoleArn = "string",
    MultiAz = false,
    Name = "string",
    NcharCharacterSetName = "string",
    NetworkType = "string",
    OptionGroupName = "string",
    ParameterGroupName = "string",
    Password = "string",
    PerformanceInsightsEnabled = false,
    PerformanceInsightsKmsKeyId = "string",
    PerformanceInsightsRetentionPeriod = 0,
    Port = 0,
    PubliclyAccessible = false,
    ReplicaMode = "string",
    ReplicateSourceDb = "string",
    RestoreToPointInTime = new Aws.Rds.Inputs.InstanceRestoreToPointInTimeArgs
    {
        RestoreTime = "string",
        SourceDbInstanceAutomatedBackupsArn = "string",
        SourceDbInstanceIdentifier = "string",
        SourceDbiResourceId = "string",
        UseLatestRestorableTime = false,
    },
    S3Import = new Aws.Rds.Inputs.InstanceS3ImportArgs
    {
        BucketName = "string",
        IngestionRole = "string",
        SourceEngine = "string",
        SourceEngineVersion = "string",
        BucketPrefix = "string",
    },
    SkipFinalSnapshot = false,
    SnapshotIdentifier = "string",
    StorageEncrypted = false,
    StorageThroughput = 0,
    StorageType = "string",
    Tags = 
    {
        { "string", "string" },
    },
    Timezone = "string",
    Username = "string",
    VpcSecurityGroupIds = new[]
    {
        "string",
    },
});

example, err := rds.NewInstance(ctx, "exampleinstanceResourceResourceFromRdsinstance", &rds.InstanceArgs{
	InstanceClass:            pulumi.String("string"),
	AllocatedStorage:         pulumi.Int(0),
	AllowMajorVersionUpgrade: pulumi.Bool(false),
	ApplyImmediately:         pulumi.Bool(false),
	AutoMinorVersionUpgrade:  pulumi.Bool(false),
	AvailabilityZone:         pulumi.String("string"),
	BackupRetentionPeriod:    pulumi.Int(0),
	BackupWindow:             pulumi.String("string"),
	BlueGreenUpdate: &rds.InstanceBlueGreenUpdateArgs{
		Enabled: pulumi.Bool(false),
	},
	CaCertIdentifier:         pulumi.String("string"),
	CharacterSetName:         pulumi.String("string"),
	CopyTagsToSnapshot:       pulumi.Bool(false),
	CustomIamInstanceProfile: pulumi.String("string"),
	CustomerOwnedIpEnabled:   pulumi.Bool(false),
	DbName:                   pulumi.String("string"),
	DbSubnetGroupName:        pulumi.String("string"),
	DeleteAutomatedBackups:   pulumi.Bool(false),
	DeletionProtection:       pulumi.Bool(false),
	Domain:                   pulumi.String("string"),
	DomainIamRoleName:        pulumi.String("string"),
	EnabledCloudwatchLogsExports: pulumi.StringArray{
		pulumi.String("string"),
	},
	Engine:                             pulumi.String("string"),
	EngineVersion:                      pulumi.String("string"),
	FinalSnapshotIdentifier:            pulumi.String("string"),
	IamDatabaseAuthenticationEnabled:   pulumi.Bool(false),
	Identifier:                         pulumi.String("string"),
	IdentifierPrefix:                   pulumi.String("string"),
	Iops:                               pulumi.Int(0),
	KmsKeyId:                           pulumi.String("string"),
	LicenseModel:                       pulumi.String("string"),
	MaintenanceWindow:                  pulumi.String("string"),
	ManageMasterUserPassword:           pulumi.Bool(false),
	MasterUserSecretKmsKeyId:           pulumi.String("string"),
	MaxAllocatedStorage:                pulumi.Int(0),
	MonitoringInterval:                 pulumi.Int(0),
	MonitoringRoleArn:                  pulumi.String("string"),
	MultiAz:                            pulumi.Bool(false),
	Name:                               pulumi.String("string"),
	NcharCharacterSetName:              pulumi.String("string"),
	NetworkType:                        pulumi.String("string"),
	OptionGroupName:                    pulumi.String("string"),
	ParameterGroupName:                 pulumi.String("string"),
	Password:                           pulumi.String("string"),
	PerformanceInsightsEnabled:         pulumi.Bool(false),
	PerformanceInsightsKmsKeyId:        pulumi.String("string"),
	PerformanceInsightsRetentionPeriod: pulumi.Int(0),
	Port:                               pulumi.Int(0),
	PubliclyAccessible:                 pulumi.Bool(false),
	ReplicaMode:                        pulumi.String("string"),
	ReplicateSourceDb:                  pulumi.String("string"),
	RestoreToPointInTime: &rds.InstanceRestoreToPointInTimeArgs{
		RestoreTime:                         pulumi.String("string"),
		SourceDbInstanceAutomatedBackupsArn: pulumi.String("string"),
		SourceDbInstanceIdentifier:          pulumi.String("string"),
		SourceDbiResourceId:                 pulumi.String("string"),
		UseLatestRestorableTime:             pulumi.Bool(false),
	},
	S3Import: &rds.InstanceS3ImportArgs{
		BucketName:          pulumi.String("string"),
		IngestionRole:       pulumi.String("string"),
		SourceEngine:        pulumi.String("string"),
		SourceEngineVersion: pulumi.String("string"),
		BucketPrefix:        pulumi.String("string"),
	},
	SkipFinalSnapshot:  pulumi.Bool(false),
	SnapshotIdentifier: pulumi.String("string"),
	StorageEncrypted:   pulumi.Bool(false),
	StorageThroughput:  pulumi.Int(0),
	StorageType:        pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Timezone: pulumi.String("string"),
	Username: pulumi.String("string"),
	VpcSecurityGroupIds: pulumi.StringArray{
		pulumi.String("string"),
	},
})

var exampleinstanceResourceResourceFromRdsinstance = new com.pulumi.aws.rds.Instance("exampleinstanceResourceResourceFromRdsinstance", com.pulumi.aws.rds.InstanceArgs.builder()
    .instanceClass("string")
    .allocatedStorage(0)
    .allowMajorVersionUpgrade(false)
    .applyImmediately(false)
    .autoMinorVersionUpgrade(false)
    .availabilityZone("string")
    .backupRetentionPeriod(0)
    .backupWindow("string")
    .blueGreenUpdate(InstanceBlueGreenUpdateArgs.builder()
        .enabled(false)
        .build())
    .caCertIdentifier("string")
    .characterSetName("string")
    .copyTagsToSnapshot(false)
    .customIamInstanceProfile("string")
    .customerOwnedIpEnabled(false)
    .dbName("string")
    .dbSubnetGroupName("string")
    .deleteAutomatedBackups(false)
    .deletionProtection(false)
    .domain("string")
    .domainIamRoleName("string")
    .enabledCloudwatchLogsExports("string")
    .engine("string")
    .engineVersion("string")
    .finalSnapshotIdentifier("string")
    .iamDatabaseAuthenticationEnabled(false)
    .identifier("string")
    .identifierPrefix("string")
    .iops(0)
    .kmsKeyId("string")
    .licenseModel("string")
    .maintenanceWindow("string")
    .manageMasterUserPassword(false)
    .masterUserSecretKmsKeyId("string")
    .maxAllocatedStorage(0)
    .monitoringInterval(0)
    .monitoringRoleArn("string")
    .multiAz(false)
    .name("string")
    .ncharCharacterSetName("string")
    .networkType("string")
    .optionGroupName("string")
    .parameterGroupName("string")
    .password("string")
    .performanceInsightsEnabled(false)
    .performanceInsightsKmsKeyId("string")
    .performanceInsightsRetentionPeriod(0)
    .port(0)
    .publiclyAccessible(false)
    .replicaMode("string")
    .replicateSourceDb("string")
    .restoreToPointInTime(InstanceRestoreToPointInTimeArgs.builder()
        .restoreTime("string")
        .sourceDbInstanceAutomatedBackupsArn("string")
        .sourceDbInstanceIdentifier("string")
        .sourceDbiResourceId("string")
        .useLatestRestorableTime(false)
        .build())
    .s3Import(InstanceS3ImportArgs.builder()
        .bucketName("string")
        .ingestionRole("string")
        .sourceEngine("string")
        .sourceEngineVersion("string")
        .bucketPrefix("string")
        .build())
    .skipFinalSnapshot(false)
    .snapshotIdentifier("string")
    .storageEncrypted(false)
    .storageThroughput(0)
    .storageType("string")
    .tags(Map.of("string", "string"))
    .timezone("string")
    .username("string")
    .vpcSecurityGroupIds("string")
    .build());

exampleinstance_resource_resource_from_rdsinstance = aws.rds.Instance("exampleinstanceResourceResourceFromRdsinstance",
    instance_class="string",
    allocated_storage=0,
    allow_major_version_upgrade=False,
    apply_immediately=False,
    auto_minor_version_upgrade=False,
    availability_zone="string",
    backup_retention_period=0,
    backup_window="string",
    blue_green_update={
        "enabled": False,
    },
    ca_cert_identifier="string",
    character_set_name="string",
    copy_tags_to_snapshot=False,
    custom_iam_instance_profile="string",
    customer_owned_ip_enabled=False,
    db_name="string",
    db_subnet_group_name="string",
    delete_automated_backups=False,
    deletion_protection=False,
    domain="string",
    domain_iam_role_name="string",
    enabled_cloudwatch_logs_exports=["string"],
    engine="string",
    engine_version="string",
    final_snapshot_identifier="string",
    iam_database_authentication_enabled=False,
    identifier="string",
    identifier_prefix="string",
    iops=0,
    kms_key_id="string",
    license_model="string",
    maintenance_window="string",
    manage_master_user_password=False,
    master_user_secret_kms_key_id="string",
    max_allocated_storage=0,
    monitoring_interval=0,
    monitoring_role_arn="string",
    multi_az=False,
    name="string",
    nchar_character_set_name="string",
    network_type="string",
    option_group_name="string",
    parameter_group_name="string",
    password="string",
    performance_insights_enabled=False,
    performance_insights_kms_key_id="string",
    performance_insights_retention_period=0,
    port=0,
    publicly_accessible=False,
    replica_mode="string",
    replicate_source_db="string",
    restore_to_point_in_time={
        "restore_time": "string",
        "source_db_instance_automated_backups_arn": "string",
        "source_db_instance_identifier": "string",
        "source_dbi_resource_id": "string",
        "use_latest_restorable_time": False,
    },
    s3_import={
        "bucket_name": "string",
        "ingestion_role": "string",
        "source_engine": "string",
        "source_engine_version": "string",
        "bucket_prefix": "string",
    },
    skip_final_snapshot=False,
    snapshot_identifier="string",
    storage_encrypted=False,
    storage_throughput=0,
    storage_type="string",
    tags={
        "string": "string",
    },
    timezone="string",
    username="string",
    vpc_security_group_ids=["string"])

const exampleinstanceResourceResourceFromRdsinstance = new aws.rds.Instance("exampleinstanceResourceResourceFromRdsinstance", {
    instanceClass: "string",
    allocatedStorage: 0,
    allowMajorVersionUpgrade: false,
    applyImmediately: false,
    autoMinorVersionUpgrade: false,
    availabilityZone: "string",
    backupRetentionPeriod: 0,
    backupWindow: "string",
    blueGreenUpdate: {
        enabled: false,
    },
    caCertIdentifier: "string",
    characterSetName: "string",
    copyTagsToSnapshot: false,
    customIamInstanceProfile: "string",
    customerOwnedIpEnabled: false,
    dbName: "string",
    dbSubnetGroupName: "string",
    deleteAutomatedBackups: false,
    deletionProtection: false,
    domain: "string",
    domainIamRoleName: "string",
    enabledCloudwatchLogsExports: ["string"],
    engine: "string",
    engineVersion: "string",
    finalSnapshotIdentifier: "string",
    iamDatabaseAuthenticationEnabled: false,
    identifier: "string",
    identifierPrefix: "string",
    iops: 0,
    kmsKeyId: "string",
    licenseModel: "string",
    maintenanceWindow: "string",
    manageMasterUserPassword: false,
    masterUserSecretKmsKeyId: "string",
    maxAllocatedStorage: 0,
    monitoringInterval: 0,
    monitoringRoleArn: "string",
    multiAz: false,
    name: "string",
    ncharCharacterSetName: "string",
    networkType: "string",
    optionGroupName: "string",
    parameterGroupName: "string",
    password: "string",
    performanceInsightsEnabled: false,
    performanceInsightsKmsKeyId: "string",
    performanceInsightsRetentionPeriod: 0,
    port: 0,
    publiclyAccessible: false,
    replicaMode: "string",
    replicateSourceDb: "string",
    restoreToPointInTime: {
        restoreTime: "string",
        sourceDbInstanceAutomatedBackupsArn: "string",
        sourceDbInstanceIdentifier: "string",
        sourceDbiResourceId: "string",
        useLatestRestorableTime: false,
    },
    s3Import: {
        bucketName: "string",
        ingestionRole: "string",
        sourceEngine: "string",
        sourceEngineVersion: "string",
        bucketPrefix: "string",
    },
    skipFinalSnapshot: false,
    snapshotIdentifier: "string",
    storageEncrypted: false,
    storageThroughput: 0,
    storageType: "string",
    tags: {
        string: "string",
    },
    timezone: "string",
    username: "string",
    vpcSecurityGroupIds: ["string"],
});

type: aws:rds:Instance
properties:
    allocatedStorage: 0
    allowMajorVersionUpgrade: false
    applyImmediately: false
    autoMinorVersionUpgrade: false
    availabilityZone: string
    backupRetentionPeriod: 0
    backupWindow: string
    blueGreenUpdate:
        enabled: false
    caCertIdentifier: string
    characterSetName: string
    copyTagsToSnapshot: false
    customIamInstanceProfile: string
    customerOwnedIpEnabled: false
    dbName: string
    dbSubnetGroupName: string
    deleteAutomatedBackups: false
    deletionProtection: false
    domain: string
    domainIamRoleName: string
    enabledCloudwatchLogsExports:
        - string
    engine: string
    engineVersion: string
    finalSnapshotIdentifier: string
    iamDatabaseAuthenticationEnabled: false
    identifier: string
    identifierPrefix: string
    instanceClass: string
    iops: 0
    kmsKeyId: string
    licenseModel: string
    maintenanceWindow: string
    manageMasterUserPassword: false
    masterUserSecretKmsKeyId: string
    maxAllocatedStorage: 0
    monitoringInterval: 0
    monitoringRoleArn: string
    multiAz: false
    name: string
    ncharCharacterSetName: string
    networkType: string
    optionGroupName: string
    parameterGroupName: string
    password: string
    performanceInsightsEnabled: false
    performanceInsightsKmsKeyId: string
    performanceInsightsRetentionPeriod: 0
    port: 0
    publiclyAccessible: false
    replicaMode: string
    replicateSourceDb: string
    restoreToPointInTime:
        restoreTime: string
        sourceDbInstanceAutomatedBackupsArn: string
        sourceDbInstanceIdentifier: string
        sourceDbiResourceId: string
        useLatestRestorableTime: false
    s3Import:
        bucketName: string
        bucketPrefix: string
        ingestionRole: string
        sourceEngine: string
        sourceEngineVersion: string
    skipFinalSnapshot: false
    snapshotIdentifier: string
    storageEncrypted: false
    storageThroughput: 0
    storageType: string
    tags:
        string: string
    timezone: string
    username: string
    vpcSecurityGroupIds:
        - string

Instance Resource Properties

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

Inputs

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

The Instance resource accepts the following input properties:

InstanceClass string | Pulumi.Aws.Rds.InstanceType: The instance type of the RDS instance.
AllocatedStorage int: The allocated storage in gibibytes. If max_allocated_storage is configured, this argument represents the initial storage allocation and differences from the configuration will be ignored automatically when Storage Autoscaling occurs. If replicate_source_db is set, the value is ignored during the creation of the instance.
AllowMajorVersionUpgrade bool: Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
ApplyImmediately bool: Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.
AutoMinorVersionUpgrade bool: Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaults to true.
AvailabilityZone string: The AZ for the RDS instance.
BackupRetentionPeriod int: The days to retain backups for. Must be between 0 and 35. Default is 0. Must be greater than 0 if the database is used as a source for a [Read Replica][instance-replication], uses low-downtime updates, or will use [RDS Blue/Green deployments][blue-green].
BackupWindow string: The daily time range (in UTC) during which automated backups are created if they are enabled. Example: "09:46-10:16". Must not overlap with maintenance_window.
BlueGreenUpdate InstanceBlueGreenUpdate: Enables low-downtime updates using [RDS Blue/Green deployments][blue-green]. See blue_green_update below
CaCertIdentifier string: The identifier of the CA certificate for the DB instance.
CharacterSetName string: The character set name to use for DB encoding in Oracle and Microsoft SQL instances (collation). This can't be changed. See Oracle Character Sets Supported in Amazon RDS or Server-Level Collation for Microsoft SQL Server for more information.
CopyTagsToSnapshot bool: Copy all Instance tags to snapshots. Default is false.
CustomIamInstanceProfile string: The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
CustomerOwnedIpEnabled bool: Indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. See CoIP for RDS on Outposts for more information.
NOTE: Removing the replicate_source_db attribute from an existing RDS Replicate database managed by the provider will promote the database to a fully standalone database.
DbName string: The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Note that this does not apply for Oracle or SQL Server engines. See the AWS documentation for more details on what applies for those engines. If you are providing an Oracle db name, it needs to be in all upper case. Cannot be specified for a replica.
DbSubnetGroupName string: Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC, or in EC2 Classic, if available. When working with read replicas, it should be specified only if the source database specifies an instance in another AWS Region. See DBSubnetGroupName in API action CreateDBInstanceReadReplica for additional read replica contraints.
DeleteAutomatedBackups bool: Specifies whether to remove automated backups immediately after the DB instance is deleted. Default is true.
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.
Domain string: The ID of the Directory Service Active Directory domain to create the instance in.
DomainIamRoleName string: The name of the IAM role to be used when making API calls to the Directory Service.
EnabledCloudwatchLogsExports List<string>: Set of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine). MySQL and MariaDB: audit, error, general, slowquery. PostgreSQL: postgresql, upgrade. MSSQL: agent , error. Oracle: alert, audit, listener, trace.
Engine string: The database engine to use. For supported values, see the Engine parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine must match the DB cluster's engine'. 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.
EngineVersion string: The engine version to use. If auto_minor_version_upgrade is enabled, you can provide a prefix of the version such as 5.7 (for 5.7.10). The actual engine version used is returned in the attribute engine_version_actual, see Attributes Reference below. For supported values, see the EngineVersion parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine version must match the DB cluster's engine version'.
FinalSnapshotIdentifier string: The name of your final DB snapshot when this DB instance is deleted. Must be provided if skip_final_snapshot is set to false. The value must begin with a letter, only contain alphanumeric characters and hyphens, and not end with a hyphen or contain two consecutive hyphens. Must not be provided when deleting a read replica.
IamDatabaseAuthenticationEnabled bool: Specifies whether mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
Identifier string: The name of the RDS instance, if omitted, this provider will assign a random, unique identifier. Required if restore_to_point_in_time is specified.
IdentifierPrefix string: Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
Iops int: The amount of provisioned IOPS. Setting this implies a storage_type of "io1". Can only be set when storage_type is "io1" or "gp3". Cannot be specified for gp3 storage if the allocated_storage value is below a per-engine threshold. See the RDS User Guide for details.
KmsKeyId string: The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.
LicenseModel string: (Optional, but required for some DB engines, i.e., Oracle SE1) License model information for this DB instance.
MaintenanceWindow string: The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00". See RDS Maintenance Window docs for more information.
ManageMasterUserPassword bool: Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if password is provided.
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.
MaxAllocatedStorage int: When configured, the upper limit to which Amazon RDS can automatically scale the storage of the DB instance. Configuring this will automatically ignore differences to allocated_storage. Must be greater than or equal to allocated_storage or 0 to disable Storage Autoscaling.
MonitoringInterval int: The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
MonitoringRoleArn string: The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
MultiAz bool: Specifies if the RDS instance is multi-AZ
Name string: The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Note that this does not apply for Oracle or SQL Server engines. See the AWS documentation for more details on what applies for those engines. If you are providing an Oracle db name, it needs to be in all upper case. Cannot be specified for a replica.
NcharCharacterSetName string: The national character set is used in the NCHAR, NVARCHAR2, and NCLOB data types for Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS.
NetworkType string: The network type of the DB instance. Valid values: IPV4, DUAL.
OptionGroupName string: Name of the DB option group to associate.
ParameterGroupName string: Name of the DB parameter group to associate.
Password string: (Required unless manage_master_user_password is set to true or unless a snapshot_identifier or replicate_source_db is provided or manage_master_user_password is set.) Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Cannot be set if manage_master_user_password is set to true.
PerformanceInsightsEnabled bool: Specifies whether Performance Insights are enabled. Defaults to false.
PerformanceInsightsKmsKeyId string: The ARN for the KMS key to encrypt Performance Insights data. When specifying performance_insights_kms_key_id, performance_insights_enabled needs to be set to true. Once KMS key is set, it can never be changed.
PerformanceInsightsRetentionPeriod int: Amount of time in days to retain Performance Insights data. Valid values are 7, 731 (2 years) or a multiple of 31. When specifying performance_insights_retention_period, performance_insights_enabled needs to be set to true. Defaults to '7'.
Port int: The port on which the DB accepts connections.
PubliclyAccessible bool: Bool to control if instance is publicly accessible. Default is false.
ReplicaMode string: Specifies whether the replica is in either mounted or open-read-only mode. This attribute is only supported by Oracle instances. Oracle replicas operate in open-read-only mode unless otherwise specified. See Working with Oracle Read Replicas for more information.
ReplicateSourceDb string: Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate (if replicating within a single region) or ARN of the Amazon RDS Database to replicate (if replicating cross-region). Note that if you are creating a cross-region replica of an encrypted database you will also need to specify a kms_key_id. See [DB Instance Replication][instance-replication] and Working with PostgreSQL and MySQL Read Replicas for more information on using Replication.
RestoreToPointInTime InstanceRestoreToPointInTime: A configuration block for restoring a DB instance to an arbitrary point in time. Requires the identifier argument to be set with the name of the new DB instance to be created. See Restore To Point In Time below for details.
S3Import InstanceS3Import: Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance
SecurityGroupNames List<string>: List of DB Security Groups to associate. Only used for DB Instances on the EC2-Classic Platform.
Deprecated: With the retirement of EC2-Classic the security_group_names attribute has been deprecated and will be removed in a future version.
SkipFinalSnapshot bool: Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier. Default is false.
SnapshotIdentifier string: Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05.
StorageEncrypted bool: Specifies whether the DB instance is encrypted. Note that if you are creating a cross-region read replica this field is ignored and you should instead declare kms_key_id with a valid ARN. The default is false if not specified.
StorageThroughput int: The storage throughput value for the DB instance. Can only be set when storage_type is "gp3". Cannot be specified if the allocated_storage value is below a per-engine threshold. See the RDS User Guide for details.
StorageType string | Pulumi.Aws.Rds.StorageType: One of "standard" (magnetic), "gp2" (general purpose SSD), "gp3" (general purpose SSD that needs iops independently) or "io1" (provisioned IOPS SSD). The default is "io1" if iops is specified, "gp2" if not.
Tags Dictionary<string, string>: A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Timezone string: Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information.
Username string: (Required unless a snapshot_identifier or replicate_source_db is provided) Username for the master DB user. Cannot be specified for a replica.
VpcSecurityGroupIds List<string>: List of VPC security groups to associate.

InstanceClass string | InstanceType: The instance type of the RDS instance.
AllocatedStorage int: The allocated storage in gibibytes. If max_allocated_storage is configured, this argument represents the initial storage allocation and differences from the configuration will be ignored automatically when Storage Autoscaling occurs. If replicate_source_db is set, the value is ignored during the creation of the instance.
AllowMajorVersionUpgrade bool: Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
ApplyImmediately bool: Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.
AutoMinorVersionUpgrade bool: Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaults to true.
AvailabilityZone string: The AZ for the RDS instance.
BackupRetentionPeriod int: The days to retain backups for. Must be between 0 and 35. Default is 0. Must be greater than 0 if the database is used as a source for a [Read Replica][instance-replication], uses low-downtime updates, or will use [RDS Blue/Green deployments][blue-green].
BackupWindow string: The daily time range (in UTC) during which automated backups are created if they are enabled. Example: "09:46-10:16". Must not overlap with maintenance_window.
BlueGreenUpdate InstanceBlueGreenUpdateArgs: Enables low-downtime updates using [RDS Blue/Green deployments][blue-green]. See blue_green_update below
CaCertIdentifier string: The identifier of the CA certificate for the DB instance.
CharacterSetName string: The character set name to use for DB encoding in Oracle and Microsoft SQL instances (collation). This can't be changed. See Oracle Character Sets Supported in Amazon RDS or Server-Level Collation for Microsoft SQL Server for more information.
CopyTagsToSnapshot bool: Copy all Instance tags to snapshots. Default is false.
CustomIamInstanceProfile string: The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
CustomerOwnedIpEnabled bool: Indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. See CoIP for RDS on Outposts for more information.
NOTE: Removing the replicate_source_db attribute from an existing RDS Replicate database managed by the provider will promote the database to a fully standalone database.
DbName string: The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Note that this does not apply for Oracle or SQL Server engines. See the AWS documentation for more details on what applies for those engines. If you are providing an Oracle db name, it needs to be in all upper case. Cannot be specified for a replica.
DbSubnetGroupName string: Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC, or in EC2 Classic, if available. When working with read replicas, it should be specified only if the source database specifies an instance in another AWS Region. See DBSubnetGroupName in API action CreateDBInstanceReadReplica for additional read replica contraints.
DeleteAutomatedBackups bool: Specifies whether to remove automated backups immediately after the DB instance is deleted. Default is true.
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.
Domain string: The ID of the Directory Service Active Directory domain to create the instance in.
DomainIamRoleName string: The name of the IAM role to be used when making API calls to the Directory Service.
EnabledCloudwatchLogsExports []string: Set of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine). MySQL and MariaDB: audit, error, general, slowquery. PostgreSQL: postgresql, upgrade. MSSQL: agent , error. Oracle: alert, audit, listener, trace.
Engine string: The database engine to use. For supported values, see the Engine parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine must match the DB cluster's engine'. 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.
EngineVersion string: The engine version to use. If auto_minor_version_upgrade is enabled, you can provide a prefix of the version such as 5.7 (for 5.7.10). The actual engine version used is returned in the attribute engine_version_actual, see Attributes Reference below. For supported values, see the EngineVersion parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine version must match the DB cluster's engine version'.
FinalSnapshotIdentifier string: The name of your final DB snapshot when this DB instance is deleted. Must be provided if skip_final_snapshot is set to false. The value must begin with a letter, only contain alphanumeric characters and hyphens, and not end with a hyphen or contain two consecutive hyphens. Must not be provided when deleting a read replica.
IamDatabaseAuthenticationEnabled bool: Specifies whether mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
Identifier string: The name of the RDS instance, if omitted, this provider will assign a random, unique identifier. Required if restore_to_point_in_time is specified.
IdentifierPrefix string: Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
Iops int: The amount of provisioned IOPS. Setting this implies a storage_type of "io1". Can only be set when storage_type is "io1" or "gp3". Cannot be specified for gp3 storage if the allocated_storage value is below a per-engine threshold. See the RDS User Guide for details.
KmsKeyId string: The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.
LicenseModel string: (Optional, but required for some DB engines, i.e., Oracle SE1) License model information for this DB instance.
MaintenanceWindow string: The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00". See RDS Maintenance Window docs for more information.
ManageMasterUserPassword bool: Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if password is provided.
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.
MaxAllocatedStorage int: When configured, the upper limit to which Amazon RDS can automatically scale the storage of the DB instance. Configuring this will automatically ignore differences to allocated_storage. Must be greater than or equal to allocated_storage or 0 to disable Storage Autoscaling.
MonitoringInterval int: The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
MonitoringRoleArn string: The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
MultiAz bool: Specifies if the RDS instance is multi-AZ
Name string: The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Note that this does not apply for Oracle or SQL Server engines. See the AWS documentation for more details on what applies for those engines. If you are providing an Oracle db name, it needs to be in all upper case. Cannot be specified for a replica.
NcharCharacterSetName string: The national character set is used in the NCHAR, NVARCHAR2, and NCLOB data types for Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS.
NetworkType string: The network type of the DB instance. Valid values: IPV4, DUAL.
OptionGroupName string: Name of the DB option group to associate.
ParameterGroupName string: Name of the DB parameter group to associate.
Password string: (Required unless manage_master_user_password is set to true or unless a snapshot_identifier or replicate_source_db is provided or manage_master_user_password is set.) Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Cannot be set if manage_master_user_password is set to true.
PerformanceInsightsEnabled bool: Specifies whether Performance Insights are enabled. Defaults to false.
PerformanceInsightsKmsKeyId string: The ARN for the KMS key to encrypt Performance Insights data. When specifying performance_insights_kms_key_id, performance_insights_enabled needs to be set to true. Once KMS key is set, it can never be changed.
PerformanceInsightsRetentionPeriod int: Amount of time in days to retain Performance Insights data. Valid values are 7, 731 (2 years) or a multiple of 31. When specifying performance_insights_retention_period, performance_insights_enabled needs to be set to true. Defaults to '7'.
Port int: The port on which the DB accepts connections.
PubliclyAccessible bool: Bool to control if instance is publicly accessible. Default is false.
ReplicaMode string: Specifies whether the replica is in either mounted or open-read-only mode. This attribute is only supported by Oracle instances. Oracle replicas operate in open-read-only mode unless otherwise specified. See Working with Oracle Read Replicas for more information.
ReplicateSourceDb string: Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate (if replicating within a single region) or ARN of the Amazon RDS Database to replicate (if replicating cross-region). Note that if you are creating a cross-region replica of an encrypted database you will also need to specify a kms_key_id. See [DB Instance Replication][instance-replication] and Working with PostgreSQL and MySQL Read Replicas for more information on using Replication.
RestoreToPointInTime InstanceRestoreToPointInTimeArgs: A configuration block for restoring a DB instance to an arbitrary point in time. Requires the identifier argument to be set with the name of the new DB instance to be created. See Restore To Point In Time below for details.
S3Import InstanceS3ImportArgs: Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance
SecurityGroupNames []string: List of DB Security Groups to associate. Only used for DB Instances on the EC2-Classic Platform.
Deprecated: With the retirement of EC2-Classic the security_group_names attribute has been deprecated and will be removed in a future version.
SkipFinalSnapshot bool: Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier. Default is false.
SnapshotIdentifier string: Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05.
StorageEncrypted bool: Specifies whether the DB instance is encrypted. Note that if you are creating a cross-region read replica this field is ignored and you should instead declare kms_key_id with a valid ARN. The default is false if not specified.
StorageThroughput int: The storage throughput value for the DB instance. Can only be set when storage_type is "gp3". Cannot be specified if the allocated_storage value is below a per-engine threshold. See the RDS User Guide for details.
StorageType string | StorageType: One of "standard" (magnetic), "gp2" (general purpose SSD), "gp3" (general purpose SSD that needs iops independently) or "io1" (provisioned IOPS SSD). The default is "io1" if iops is specified, "gp2" if not.
Tags map[string]string: A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Timezone string: Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information.
Username string: (Required unless a snapshot_identifier or replicate_source_db is provided) Username for the master DB user. Cannot be specified for a replica.
VpcSecurityGroupIds []string: List of VPC security groups to associate.

instanceClass String | InstanceType: The instance type of the RDS instance.
allocatedStorage Integer: The allocated storage in gibibytes. If max_allocated_storage is configured, this argument represents the initial storage allocation and differences from the configuration will be ignored automatically when Storage Autoscaling occurs. If replicate_source_db is set, the value is ignored during the creation of the instance.
allowMajorVersionUpgrade Boolean: Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
applyImmediately Boolean: Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.
autoMinorVersionUpgrade Boolean: Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaults to true.
availabilityZone String: The AZ for the RDS instance.
backupRetentionPeriod Integer: The days to retain backups for. Must be between 0 and 35. Default is 0. Must be greater than 0 if the database is used as a source for a [Read Replica][instance-replication], uses low-downtime updates, or will use [RDS Blue/Green deployments][blue-green].
backupWindow String: The daily time range (in UTC) during which automated backups are created if they are enabled. Example: "09:46-10:16". Must not overlap with maintenance_window.
blueGreenUpdate InstanceBlueGreenUpdate: Enables low-downtime updates using [RDS Blue/Green deployments][blue-green]. See blue_green_update below
caCertIdentifier String: The identifier of the CA certificate for the DB instance.
characterSetName String: The character set name to use for DB encoding in Oracle and Microsoft SQL instances (collation). This can't be changed. See Oracle Character Sets Supported in Amazon RDS or Server-Level Collation for Microsoft SQL Server for more information.
copyTagsToSnapshot Boolean: Copy all Instance tags to snapshots. Default is false.
customIamInstanceProfile String: The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
customerOwnedIpEnabled Boolean: Indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. See CoIP for RDS on Outposts for more information.
NOTE: Removing the replicate_source_db attribute from an existing RDS Replicate database managed by the provider will promote the database to a fully standalone database.
dbName String: The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Note that this does not apply for Oracle or SQL Server engines. See the AWS documentation for more details on what applies for those engines. If you are providing an Oracle db name, it needs to be in all upper case. Cannot be specified for a replica.
dbSubnetGroupName String: Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC, or in EC2 Classic, if available. When working with read replicas, it should be specified only if the source database specifies an instance in another AWS Region. See DBSubnetGroupName in API action CreateDBInstanceReadReplica for additional read replica contraints.
deleteAutomatedBackups Boolean: Specifies whether to remove automated backups immediately after the DB instance is deleted. Default is true.
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.
domain String: The ID of the Directory Service Active Directory domain to create the instance in.
domainIamRoleName String: The name of the IAM role to be used when making API calls to the Directory Service.
enabledCloudwatchLogsExports List<String>: Set of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine). MySQL and MariaDB: audit, error, general, slowquery. PostgreSQL: postgresql, upgrade. MSSQL: agent , error. Oracle: alert, audit, listener, trace.
engine String: The database engine to use. For supported values, see the Engine parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine must match the DB cluster's engine'. 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.
engineVersion String: The engine version to use. If auto_minor_version_upgrade is enabled, you can provide a prefix of the version such as 5.7 (for 5.7.10). The actual engine version used is returned in the attribute engine_version_actual, see Attributes Reference below. For supported values, see the EngineVersion parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine version must match the DB cluster's engine version'.
finalSnapshotIdentifier String: The name of your final DB snapshot when this DB instance is deleted. Must be provided if skip_final_snapshot is set to false. The value must begin with a letter, only contain alphanumeric characters and hyphens, and not end with a hyphen or contain two consecutive hyphens. Must not be provided when deleting a read replica.
iamDatabaseAuthenticationEnabled Boolean: Specifies whether mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
identifier String: The name of the RDS instance, if omitted, this provider will assign a random, unique identifier. Required if restore_to_point_in_time is specified.
identifierPrefix String: Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
iops Integer: The amount of provisioned IOPS. Setting this implies a storage_type of "io1". Can only be set when storage_type is "io1" or "gp3". Cannot be specified for gp3 storage if the allocated_storage value is below a per-engine threshold. See the RDS User Guide for details.
kmsKeyId String: The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.
licenseModel String: (Optional, but required for some DB engines, i.e., Oracle SE1) License model information for this DB instance.
maintenanceWindow String: The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00". See RDS Maintenance Window docs for more information.
manageMasterUserPassword Boolean: Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if password is provided.
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.
maxAllocatedStorage Integer: When configured, the upper limit to which Amazon RDS can automatically scale the storage of the DB instance. Configuring this will automatically ignore differences to allocated_storage. Must be greater than or equal to allocated_storage or 0 to disable Storage Autoscaling.
monitoringInterval Integer: The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
monitoringRoleArn String: The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
multiAz Boolean: Specifies if the RDS instance is multi-AZ
name String: The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Note that this does not apply for Oracle or SQL Server engines. See the AWS documentation for more details on what applies for those engines. If you are providing an Oracle db name, it needs to be in all upper case. Cannot be specified for a replica.
ncharCharacterSetName String: The national character set is used in the NCHAR, NVARCHAR2, and NCLOB data types for Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS.
networkType String: The network type of the DB instance. Valid values: IPV4, DUAL.
optionGroupName String: Name of the DB option group to associate.
parameterGroupName String: Name of the DB parameter group to associate.
password String: (Required unless manage_master_user_password is set to true or unless a snapshot_identifier or replicate_source_db is provided or manage_master_user_password is set.) Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Cannot be set if manage_master_user_password is set to true.
performanceInsightsEnabled Boolean: Specifies whether Performance Insights are enabled. Defaults to false.
performanceInsightsKmsKeyId String: The ARN for the KMS key to encrypt Performance Insights data. When specifying performance_insights_kms_key_id, performance_insights_enabled needs to be set to true. Once KMS key is set, it can never be changed.
performanceInsightsRetentionPeriod Integer: Amount of time in days to retain Performance Insights data. Valid values are 7, 731 (2 years) or a multiple of 31. When specifying performance_insights_retention_period, performance_insights_enabled needs to be set to true. Defaults to '7'.
port Integer: The port on which the DB accepts connections.
publiclyAccessible Boolean: Bool to control if instance is publicly accessible. Default is false.
replicaMode String: Specifies whether the replica is in either mounted or open-read-only mode. This attribute is only supported by Oracle instances. Oracle replicas operate in open-read-only mode unless otherwise specified. See Working with Oracle Read Replicas for more information.
replicateSourceDb String: Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate (if replicating within a single region) or ARN of the Amazon RDS Database to replicate (if replicating cross-region). Note that if you are creating a cross-region replica of an encrypted database you will also need to specify a kms_key_id. See [DB Instance Replication][instance-replication] and Working with PostgreSQL and MySQL Read Replicas for more information on using Replication.
restoreToPointInTime InstanceRestoreToPointInTime: A configuration block for restoring a DB instance to an arbitrary point in time. Requires the identifier argument to be set with the name of the new DB instance to be created. See Restore To Point In Time below for details.
s3Import InstanceS3Import: Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance
securityGroupNames List<String>: List of DB Security Groups to associate. Only used for DB Instances on the EC2-Classic Platform.
Deprecated: With the retirement of EC2-Classic the security_group_names attribute has been deprecated and will be removed in a future version.
skipFinalSnapshot Boolean: Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier. Default is false.
snapshotIdentifier String: Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05.
storageEncrypted Boolean: Specifies whether the DB instance is encrypted. Note that if you are creating a cross-region read replica this field is ignored and you should instead declare kms_key_id with a valid ARN. The default is false if not specified.
storageThroughput Integer: The storage throughput value for the DB instance. Can only be set when storage_type is "gp3". Cannot be specified if the allocated_storage value is below a per-engine threshold. See the RDS User Guide for details.
storageType String | StorageType: One of "standard" (magnetic), "gp2" (general purpose SSD), "gp3" (general purpose SSD that needs iops independently) or "io1" (provisioned IOPS SSD). The default is "io1" if iops is specified, "gp2" if not.
tags Map<String,String>: A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
timezone String: Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information.
username String: (Required unless a snapshot_identifier or replicate_source_db is provided) Username for the master DB user. Cannot be specified for a replica.
vpcSecurityGroupIds List<String>: List of VPC security groups to associate.

instanceClass string | InstanceType: The instance type of the RDS instance.
allocatedStorage number: The allocated storage in gibibytes. If max_allocated_storage is configured, this argument represents the initial storage allocation and differences from the configuration will be ignored automatically when Storage Autoscaling occurs. If replicate_source_db is set, the value is ignored during the creation of the instance.
allowMajorVersionUpgrade boolean: Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
applyImmediately boolean: Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.
autoMinorVersionUpgrade boolean: Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaults to true.
availabilityZone string: The AZ for the RDS instance.
backupRetentionPeriod number: The days to retain backups for. Must be between 0 and 35. Default is 0. Must be greater than 0 if the database is used as a source for a [Read Replica][instance-replication], uses low-downtime updates, or will use [RDS Blue/Green deployments][blue-green].
backupWindow string: The daily time range (in UTC) during which automated backups are created if they are enabled. Example: "09:46-10:16". Must not overlap with maintenance_window.
blueGreenUpdate InstanceBlueGreenUpdate: Enables low-downtime updates using [RDS Blue/Green deployments][blue-green]. See blue_green_update below
caCertIdentifier string: The identifier of the CA certificate for the DB instance.
characterSetName string: The character set name to use for DB encoding in Oracle and Microsoft SQL instances (collation). This can't be changed. See Oracle Character Sets Supported in Amazon RDS or Server-Level Collation for Microsoft SQL Server for more information.
copyTagsToSnapshot boolean: Copy all Instance tags to snapshots. Default is false.
customIamInstanceProfile string: The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
customerOwnedIpEnabled boolean: Indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. See CoIP for RDS on Outposts for more information.
NOTE: Removing the replicate_source_db attribute from an existing RDS Replicate database managed by the provider will promote the database to a fully standalone database.
dbName string: The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Note that this does not apply for Oracle or SQL Server engines. See the AWS documentation for more details on what applies for those engines. If you are providing an Oracle db name, it needs to be in all upper case. Cannot be specified for a replica.
dbSubnetGroupName string: Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC, or in EC2 Classic, if available. When working with read replicas, it should be specified only if the source database specifies an instance in another AWS Region. See DBSubnetGroupName in API action CreateDBInstanceReadReplica for additional read replica contraints.
deleteAutomatedBackups boolean: Specifies whether to remove automated backups immediately after the DB instance is deleted. Default is true.
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.
domain string: The ID of the Directory Service Active Directory domain to create the instance in.
domainIamRoleName string: The name of the IAM role to be used when making API calls to the Directory Service.
enabledCloudwatchLogsExports string[]: Set of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine). MySQL and MariaDB: audit, error, general, slowquery. PostgreSQL: postgresql, upgrade. MSSQL: agent , error. Oracle: alert, audit, listener, trace.
engine string: The database engine to use. For supported values, see the Engine parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine must match the DB cluster's engine'. 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.
engineVersion string: The engine version to use. If auto_minor_version_upgrade is enabled, you can provide a prefix of the version such as 5.7 (for 5.7.10). The actual engine version used is returned in the attribute engine_version_actual, see Attributes Reference below. For supported values, see the EngineVersion parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine version must match the DB cluster's engine version'.
finalSnapshotIdentifier string: The name of your final DB snapshot when this DB instance is deleted. Must be provided if skip_final_snapshot is set to false. The value must begin with a letter, only contain alphanumeric characters and hyphens, and not end with a hyphen or contain two consecutive hyphens. Must not be provided when deleting a read replica.
iamDatabaseAuthenticationEnabled boolean: Specifies whether mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
identifier string: The name of the RDS instance, if omitted, this provider will assign a random, unique identifier. Required if restore_to_point_in_time is specified.
identifierPrefix string: Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
iops number: The amount of provisioned IOPS. Setting this implies a storage_type of "io1". Can only be set when storage_type is "io1" or "gp3". Cannot be specified for gp3 storage if the allocated_storage value is below a per-engine threshold. See the RDS User Guide for details.
kmsKeyId string: The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.
licenseModel string: (Optional, but required for some DB engines, i.e., Oracle SE1) License model information for this DB instance.
maintenanceWindow string: The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00". See RDS Maintenance Window docs for more information.
manageMasterUserPassword boolean: Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if password is provided.
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.
maxAllocatedStorage number: When configured, the upper limit to which Amazon RDS can automatically scale the storage of the DB instance. Configuring this will automatically ignore differences to allocated_storage. Must be greater than or equal to allocated_storage or 0 to disable Storage Autoscaling.
monitoringInterval number: The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
monitoringRoleArn string: The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
multiAz boolean: Specifies if the RDS instance is multi-AZ
name string: The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Note that this does not apply for Oracle or SQL Server engines. See the AWS documentation for more details on what applies for those engines. If you are providing an Oracle db name, it needs to be in all upper case. Cannot be specified for a replica.
ncharCharacterSetName string: The national character set is used in the NCHAR, NVARCHAR2, and NCLOB data types for Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS.
networkType string: The network type of the DB instance. Valid values: IPV4, DUAL.
optionGroupName string: Name of the DB option group to associate.
parameterGroupName string: Name of the DB parameter group to associate.
password string: (Required unless manage_master_user_password is set to true or unless a snapshot_identifier or replicate_source_db is provided or manage_master_user_password is set.) Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Cannot be set if manage_master_user_password is set to true.
performanceInsightsEnabled boolean: Specifies whether Performance Insights are enabled. Defaults to false.
performanceInsightsKmsKeyId string: The ARN for the KMS key to encrypt Performance Insights data. When specifying performance_insights_kms_key_id, performance_insights_enabled needs to be set to true. Once KMS key is set, it can never be changed.
performanceInsightsRetentionPeriod number: Amount of time in days to retain Performance Insights data. Valid values are 7, 731 (2 years) or a multiple of 31. When specifying performance_insights_retention_period, performance_insights_enabled needs to be set to true. Defaults to '7'.
port number: The port on which the DB accepts connections.
publiclyAccessible boolean: Bool to control if instance is publicly accessible. Default is false.
replicaMode string: Specifies whether the replica is in either mounted or open-read-only mode. This attribute is only supported by Oracle instances. Oracle replicas operate in open-read-only mode unless otherwise specified. See Working with Oracle Read Replicas for more information.
replicateSourceDb string: Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate (if replicating within a single region) or ARN of the Amazon RDS Database to replicate (if replicating cross-region). Note that if you are creating a cross-region replica of an encrypted database you will also need to specify a kms_key_id. See [DB Instance Replication][instance-replication] and Working with PostgreSQL and MySQL Read Replicas for more information on using Replication.
restoreToPointInTime InstanceRestoreToPointInTime: A configuration block for restoring a DB instance to an arbitrary point in time. Requires the identifier argument to be set with the name of the new DB instance to be created. See Restore To Point In Time below for details.
s3Import InstanceS3Import: Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance
securityGroupNames string[]: List of DB Security Groups to associate. Only used for DB Instances on the EC2-Classic Platform.
Deprecated: With the retirement of EC2-Classic the security_group_names attribute has been deprecated and will be removed in a future version.
skipFinalSnapshot boolean: Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier. Default is false.
snapshotIdentifier string: Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05.
storageEncrypted boolean: Specifies whether the DB instance is encrypted. Note that if you are creating a cross-region read replica this field is ignored and you should instead declare kms_key_id with a valid ARN. The default is false if not specified.
storageThroughput number: The storage throughput value for the DB instance. Can only be set when storage_type is "gp3". Cannot be specified if the allocated_storage value is below a per-engine threshold. See the RDS User Guide for details.
storageType string | StorageType: One of "standard" (magnetic), "gp2" (general purpose SSD), "gp3" (general purpose SSD that needs iops independently) or "io1" (provisioned IOPS SSD). The default is "io1" if iops is specified, "gp2" if not.
tags {[key: string]: string}: A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
timezone string: Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information.
username string: (Required unless a snapshot_identifier or replicate_source_db is provided) Username for the master DB user. Cannot be specified for a replica.
vpcSecurityGroupIds string[]: List of VPC security groups to associate.

instance_class str | InstanceType: The instance type of the RDS instance.
allocated_storage int: The allocated storage in gibibytes. If max_allocated_storage is configured, this argument represents the initial storage allocation and differences from the configuration will be ignored automatically when Storage Autoscaling occurs. If replicate_source_db is set, the value is ignored during the creation of the instance.
allow_major_version_upgrade bool: Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
apply_immediately bool: Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.
auto_minor_version_upgrade bool: Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaults to true.
availability_zone str: The AZ for the RDS instance.
backup_retention_period int: The days to retain backups for. Must be between 0 and 35. Default is 0. Must be greater than 0 if the database is used as a source for a [Read Replica][instance-replication], uses low-downtime updates, or will use [RDS Blue/Green deployments][blue-green].
backup_window str: The daily time range (in UTC) during which automated backups are created if they are enabled. Example: "09:46-10:16". Must not overlap with maintenance_window.
blue_green_update InstanceBlueGreenUpdateArgs: Enables low-downtime updates using [RDS Blue/Green deployments][blue-green]. See blue_green_update below
ca_cert_identifier str: The identifier of the CA certificate for the DB instance.
character_set_name str: The character set name to use for DB encoding in Oracle and Microsoft SQL instances (collation). This can't be changed. See Oracle Character Sets Supported in Amazon RDS or Server-Level Collation for Microsoft SQL Server for more information.
copy_tags_to_snapshot bool: Copy all Instance tags to snapshots. Default is false.
custom_iam_instance_profile str: The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
customer_owned_ip_enabled bool: Indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. See CoIP for RDS on Outposts for more information.
NOTE: Removing the replicate_source_db attribute from an existing RDS Replicate database managed by the provider will promote the database to a fully standalone database.
db_name str: The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Note that this does not apply for Oracle or SQL Server engines. See the AWS documentation for more details on what applies for those engines. If you are providing an Oracle db name, it needs to be in all upper case. Cannot be specified for a replica.
db_subnet_group_name str: Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC, or in EC2 Classic, if available. When working with read replicas, it should be specified only if the source database specifies an instance in another AWS Region. See DBSubnetGroupName in API action CreateDBInstanceReadReplica for additional read replica contraints.
delete_automated_backups bool: Specifies whether to remove automated backups immediately after the DB instance is deleted. Default is true.
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.
domain str: The ID of the Directory Service Active Directory domain to create the instance in.
domain_iam_role_name str: The name of the IAM role to be used when making API calls to the Directory Service.
enabled_cloudwatch_logs_exports Sequence[str]: Set of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine). MySQL and MariaDB: audit, error, general, slowquery. PostgreSQL: postgresql, upgrade. MSSQL: agent , error. Oracle: alert, audit, listener, trace.
engine str: The database engine to use. For supported values, see the Engine parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine must match the DB cluster's engine'. 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.
engine_version str: The engine version to use. If auto_minor_version_upgrade is enabled, you can provide a prefix of the version such as 5.7 (for 5.7.10). The actual engine version used is returned in the attribute engine_version_actual, see Attributes Reference below. For supported values, see the EngineVersion parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine version must match the DB cluster's engine version'.
final_snapshot_identifier str: The name of your final DB snapshot when this DB instance is deleted. Must be provided if skip_final_snapshot is set to false. The value must begin with a letter, only contain alphanumeric characters and hyphens, and not end with a hyphen or contain two consecutive hyphens. Must not be provided when deleting a read replica.
iam_database_authentication_enabled bool: Specifies whether mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
identifier str: The name of the RDS instance, if omitted, this provider will assign a random, unique identifier. Required if restore_to_point_in_time is specified.
identifier_prefix str: Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
iops int: The amount of provisioned IOPS. Setting this implies a storage_type of "io1". Can only be set when storage_type is "io1" or "gp3". Cannot be specified for gp3 storage if the allocated_storage value is below a per-engine threshold. See the RDS User Guide for details.
kms_key_id str: The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.
license_model str: (Optional, but required for some DB engines, i.e., Oracle SE1) License model information for this DB instance.
maintenance_window str: The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00". See RDS Maintenance Window docs for more information.
manage_master_user_password bool: Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if password is provided.
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.
max_allocated_storage int: When configured, the upper limit to which Amazon RDS can automatically scale the storage of the DB instance. Configuring this will automatically ignore differences to allocated_storage. Must be greater than or equal to allocated_storage or 0 to disable Storage Autoscaling.
monitoring_interval int: The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
monitoring_role_arn str: The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
multi_az bool: Specifies if the RDS instance is multi-AZ
name str: The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Note that this does not apply for Oracle or SQL Server engines. See the AWS documentation for more details on what applies for those engines. If you are providing an Oracle db name, it needs to be in all upper case. Cannot be specified for a replica.
nchar_character_set_name str: The national character set is used in the NCHAR, NVARCHAR2, and NCLOB data types for Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS.
network_type str: The network type of the DB instance. Valid values: IPV4, DUAL.
option_group_name str: Name of the DB option group to associate.
parameter_group_name str: Name of the DB parameter group to associate.
password str: (Required unless manage_master_user_password is set to true or unless a snapshot_identifier or replicate_source_db is provided or manage_master_user_password is set.) Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Cannot be set if manage_master_user_password is set to true.
performance_insights_enabled bool: Specifies whether Performance Insights are enabled. Defaults to false.
performance_insights_kms_key_id str: The ARN for the KMS key to encrypt Performance Insights data. When specifying performance_insights_kms_key_id, performance_insights_enabled needs to be set to true. Once KMS key is set, it can never be changed.
performance_insights_retention_period int: Amount of time in days to retain Performance Insights data. Valid values are 7, 731 (2 years) or a multiple of 31. When specifying performance_insights_retention_period, performance_insights_enabled needs to be set to true. Defaults to '7'.
port int: The port on which the DB accepts connections.
publicly_accessible bool: Bool to control if instance is publicly accessible. Default is false.
replica_mode str: Specifies whether the replica is in either mounted or open-read-only mode. This attribute is only supported by Oracle instances. Oracle replicas operate in open-read-only mode unless otherwise specified. See Working with Oracle Read Replicas for more information.
replicate_source_db str: Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate (if replicating within a single region) or ARN of the Amazon RDS Database to replicate (if replicating cross-region). Note that if you are creating a cross-region replica of an encrypted database you will also need to specify a kms_key_id. See [DB Instance Replication][instance-replication] and Working with PostgreSQL and MySQL Read Replicas for more information on using Replication.
restore_to_point_in_time InstanceRestoreToPointInTimeArgs: A configuration block for restoring a DB instance to an arbitrary point in time. Requires the identifier argument to be set with the name of the new DB instance to be created. See Restore To Point In Time below for details.
s3_import InstanceS3ImportArgs: Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance
security_group_names Sequence[str]: List of DB Security Groups to associate. Only used for DB Instances on the EC2-Classic Platform.
Deprecated: With the retirement of EC2-Classic the security_group_names attribute has been deprecated and will be removed in a future version.
skip_final_snapshot bool: Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier. Default is false.
snapshot_identifier str: Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05.
storage_encrypted bool: Specifies whether the DB instance is encrypted. Note that if you are creating a cross-region read replica this field is ignored and you should instead declare kms_key_id with a valid ARN. The default is false if not specified.
storage_throughput int: The storage throughput value for the DB instance. Can only be set when storage_type is "gp3". Cannot be specified if the allocated_storage value is below a per-engine threshold. See the RDS User Guide for details.
storage_type str | StorageType: One of "standard" (magnetic), "gp2" (general purpose SSD), "gp3" (general purpose SSD that needs iops independently) or "io1" (provisioned IOPS SSD). The default is "io1" if iops is specified, "gp2" if not.
tags Mapping[str, str]: A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
timezone str: Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information.
username str: (Required unless a snapshot_identifier or replicate_source_db is provided) Username for the master DB user. Cannot be specified for a replica.
vpc_security_group_ids Sequence[str]: List of VPC security groups to associate.

instanceClass String | "db.t4g.micro" | "db.t4g.small" | "db.t4g.medium" | "db.t4g.large" | "db.t4g.xlarge" | "db.t4g.2xlarge" | "db.t3.micro" | "db.t3.small" | "db.t3.medium" | "db.t3.large" | "db.t3.xlarge" | "db.t3.2xlarge" | "db.t2.micro" | "db.t2.small" | "db.t2.medium" | "db.t2.large" | "db.t2.xlarge" | "db.t2.2xlarge" | "db.m1.small" | "db.m1.medium" | "db.m1.large" | "db.m1.xlarge" | "db.m2.xlarge" | "db.m2.2xlarge" | "db.m2.4xlarge" | "db.m3.medium" | "db.m3.large" | "db.m3.xlarge" | "db.m3.2xlarge" | "db.m4.large" | "db.m4.xlarge" | "db.m4.2xlarge" | "db.m4.4xlarge" | "db.m4.10xlarge" | "db.m4.10xlarge" | "db.m5.large" | "db.m5.xlarge" | "db.m5.2xlarge" | "db.m5.4xlarge" | "db.m5.12xlarge" | "db.m5.24xlarge" | "db.m6g.large" | "db.m6g.xlarge" | "db.m6g.2xlarge" | "db.m6g.4xlarge" | "db.m6g.8xlarge" | "db.m6g.12xlarge" | "db.m6g.16xlarge" | "db.r3.large" | "db.r3.xlarge" | "db.r3.2xlarge" | "db.r3.4xlarge" | "db.r3.8xlarge" | "db.r4.large" | "db.r4.xlarge" | "db.r4.2xlarge" | "db.r4.4xlarge" | "db.r4.8xlarge" | "db.r4.16xlarge" | "db.r5.large" | "db.r5.xlarge" | "db.r5.2xlarge" | "db.r5.4xlarge" | "db.r5.12xlarge" | "db.r5.24xlarge" | "db.r6g.large" | "db.r6g.xlarge" | "db.r6g.2xlarge" | "db.r6g.4xlarge" | "db.r6g.8xlarge" | "db.r6g.12xlarge" | "db.r6g.16xlarge" | "db.x1.16xlarge" | "db.x1.32xlarge" | "db.x1e.xlarge" | "db.x1e.2xlarge" | "db.x1e.4xlarge" | "db.x1e.8xlarge" | "db.x1e.32xlarge": The instance type of the RDS instance.
allocatedStorage Number: The allocated storage in gibibytes. If max_allocated_storage is configured, this argument represents the initial storage allocation and differences from the configuration will be ignored automatically when Storage Autoscaling occurs. If replicate_source_db is set, the value is ignored during the creation of the instance.
allowMajorVersionUpgrade Boolean: Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
applyImmediately Boolean: Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.
autoMinorVersionUpgrade Boolean: Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaults to true.
availabilityZone String: The AZ for the RDS instance.
backupRetentionPeriod Number: The days to retain backups for. Must be between 0 and 35. Default is 0. Must be greater than 0 if the database is used as a source for a [Read Replica][instance-replication], uses low-downtime updates, or will use [RDS Blue/Green deployments][blue-green].
backupWindow String: The daily time range (in UTC) during which automated backups are created if they are enabled. Example: "09:46-10:16". Must not overlap with maintenance_window.
blueGreenUpdate Property Map: Enables low-downtime updates using [RDS Blue/Green deployments][blue-green]. See blue_green_update below
caCertIdentifier String: The identifier of the CA certificate for the DB instance.
characterSetName String: The character set name to use for DB encoding in Oracle and Microsoft SQL instances (collation). This can't be changed. See Oracle Character Sets Supported in Amazon RDS or Server-Level Collation for Microsoft SQL Server for more information.
copyTagsToSnapshot Boolean: Copy all Instance tags to snapshots. Default is false.
customIamInstanceProfile String: The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
customerOwnedIpEnabled Boolean: Indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. See CoIP for RDS on Outposts for more information.
NOTE: Removing the replicate_source_db attribute from an existing RDS Replicate database managed by the provider will promote the database to a fully standalone database.
dbName String: The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Note that this does not apply for Oracle or SQL Server engines. See the AWS documentation for more details on what applies for those engines. If you are providing an Oracle db name, it needs to be in all upper case. Cannot be specified for a replica.
dbSubnetGroupName String: Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC, or in EC2 Classic, if available. When working with read replicas, it should be specified only if the source database specifies an instance in another AWS Region. See DBSubnetGroupName in API action CreateDBInstanceReadReplica for additional read replica contraints.
deleteAutomatedBackups Boolean: Specifies whether to remove automated backups immediately after the DB instance is deleted. Default is true.
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.
domain String: The ID of the Directory Service Active Directory domain to create the instance in.
domainIamRoleName String: The name of the IAM role to be used when making API calls to the Directory Service.
enabledCloudwatchLogsExports List<String>: Set of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine). MySQL and MariaDB: audit, error, general, slowquery. PostgreSQL: postgresql, upgrade. MSSQL: agent , error. Oracle: alert, audit, listener, trace.
engine String: The database engine to use. For supported values, see the Engine parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine must match the DB cluster's engine'. 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.
engineVersion String: The engine version to use. If auto_minor_version_upgrade is enabled, you can provide a prefix of the version such as 5.7 (for 5.7.10). The actual engine version used is returned in the attribute engine_version_actual, see Attributes Reference below. For supported values, see the EngineVersion parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine version must match the DB cluster's engine version'.
finalSnapshotIdentifier String: The name of your final DB snapshot when this DB instance is deleted. Must be provided if skip_final_snapshot is set to false. The value must begin with a letter, only contain alphanumeric characters and hyphens, and not end with a hyphen or contain two consecutive hyphens. Must not be provided when deleting a read replica.
iamDatabaseAuthenticationEnabled Boolean: Specifies whether mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
identifier String: The name of the RDS instance, if omitted, this provider will assign a random, unique identifier. Required if restore_to_point_in_time is specified.
identifierPrefix String: Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
iops Number: The amount of provisioned IOPS. Setting this implies a storage_type of "io1". Can only be set when storage_type is "io1" or "gp3". Cannot be specified for gp3 storage if the allocated_storage value is below a per-engine threshold. See the RDS User Guide for details.
kmsKeyId String: The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.
licenseModel String: (Optional, but required for some DB engines, i.e., Oracle SE1) License model information for this DB instance.
maintenanceWindow String: The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00". See RDS Maintenance Window docs for more information.
manageMasterUserPassword Boolean: Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if password is provided.
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.
maxAllocatedStorage Number: When configured, the upper limit to which Amazon RDS can automatically scale the storage of the DB instance. Configuring this will automatically ignore differences to allocated_storage. Must be greater than or equal to allocated_storage or 0 to disable Storage Autoscaling.
monitoringInterval Number: The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
monitoringRoleArn String: The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
multiAz Boolean: Specifies if the RDS instance is multi-AZ
name String: The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Note that this does not apply for Oracle or SQL Server engines. See the AWS documentation for more details on what applies for those engines. If you are providing an Oracle db name, it needs to be in all upper case. Cannot be specified for a replica.
ncharCharacterSetName String: The national character set is used in the NCHAR, NVARCHAR2, and NCLOB data types for Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS.
networkType String: The network type of the DB instance. Valid values: IPV4, DUAL.
optionGroupName String: Name of the DB option group to associate.
parameterGroupName String: Name of the DB parameter group to associate.
password String: (Required unless manage_master_user_password is set to true or unless a snapshot_identifier or replicate_source_db is provided or manage_master_user_password is set.) Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Cannot be set if manage_master_user_password is set to true.
performanceInsightsEnabled Boolean: Specifies whether Performance Insights are enabled. Defaults to false.
performanceInsightsKmsKeyId String: The ARN for the KMS key to encrypt Performance Insights data. When specifying performance_insights_kms_key_id, performance_insights_enabled needs to be set to true. Once KMS key is set, it can never be changed.
performanceInsightsRetentionPeriod Number: Amount of time in days to retain Performance Insights data. Valid values are 7, 731 (2 years) or a multiple of 31. When specifying performance_insights_retention_period, performance_insights_enabled needs to be set to true. Defaults to '7'.
port Number: The port on which the DB accepts connections.
publiclyAccessible Boolean: Bool to control if instance is publicly accessible. Default is false.
replicaMode String: Specifies whether the replica is in either mounted or open-read-only mode. This attribute is only supported by Oracle instances. Oracle replicas operate in open-read-only mode unless otherwise specified. See Working with Oracle Read Replicas for more information.
replicateSourceDb String: Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate (if replicating within a single region) or ARN of the Amazon RDS Database to replicate (if replicating cross-region). Note that if you are creating a cross-region replica of an encrypted database you will also need to specify a kms_key_id. See [DB Instance Replication][instance-replication] and Working with PostgreSQL and MySQL Read Replicas for more information on using Replication.
restoreToPointInTime Property Map: A configuration block for restoring a DB instance to an arbitrary point in time. Requires the identifier argument to be set with the name of the new DB instance to be created. See Restore To Point In Time below for details.
s3Import Property Map: Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance
securityGroupNames List<String>: List of DB Security Groups to associate. Only used for DB Instances on the EC2-Classic Platform.
Deprecated: With the retirement of EC2-Classic the security_group_names attribute has been deprecated and will be removed in a future version.
skipFinalSnapshot Boolean: Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier. Default is false.
snapshotIdentifier String: Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05.
storageEncrypted Boolean: Specifies whether the DB instance is encrypted. Note that if you are creating a cross-region read replica this field is ignored and you should instead declare kms_key_id with a valid ARN. The default is false if not specified.
storageThroughput Number: The storage throughput value for the DB instance. Can only be set when storage_type is "gp3". Cannot be specified if the allocated_storage value is below a per-engine threshold. See the RDS User Guide for details.
storageType String | "standard" | "gp2" | "gp3" | "io1": One of "standard" (magnetic), "gp2" (general purpose SSD), "gp3" (general purpose SSD that needs iops independently) or "io1" (provisioned IOPS SSD). The default is "io1" if iops is specified, "gp2" if not.
tags Map<String>: A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
timezone String: Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information.
username String: (Required unless a snapshot_identifier or replicate_source_db is provided) Username for the master DB user. Cannot be specified for a replica.
vpcSecurityGroupIds List<String>: List of VPC security groups to associate.

Outputs

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

Address string: Specifies the DNS address of the DB instance.
Arn string: The ARN of the RDS instance.
Endpoint string: The connection endpoint in address:port format.
EngineVersionActual string: The running version of the database.
HostedZoneId string: Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
Id string: The provider-assigned unique ID for this managed resource.
LatestRestorableTime string: The latest time, in UTC RFC3339 format, to which a database can be restored with point-in-time restore.
ListenerEndpoints List<InstanceListenerEndpoint>: Specifies the listener connection endpoint for SQL Server Always On. See endpoint below.
MasterUserSecrets List<InstanceMasterUserSecret>: A block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.
Replicas List<string>
ResourceId string: The RDS Resource ID of this instance.
Status string: The RDS instance status.
TagsAll Dictionary<string, string>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Address string: Specifies the DNS address of the DB instance.
Arn string: The ARN of the RDS instance.
Endpoint string: The connection endpoint in address:port format.
EngineVersionActual string: The running version of the database.
HostedZoneId string: Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
Id string: The provider-assigned unique ID for this managed resource.
LatestRestorableTime string: The latest time, in UTC RFC3339 format, to which a database can be restored with point-in-time restore.
ListenerEndpoints []InstanceListenerEndpoint: Specifies the listener connection endpoint for SQL Server Always On. See endpoint below.
MasterUserSecrets []InstanceMasterUserSecret: A block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.
Replicas []string
ResourceId string: The RDS Resource ID of this instance.
Status string: The RDS instance status.
TagsAll map[string]string: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

address String: Specifies the DNS address of the DB instance.
arn String: The ARN of the RDS instance.
endpoint String: The connection endpoint in address:port format.
engineVersionActual String: The running version of the database.
hostedZoneId String: Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
id String: The provider-assigned unique ID for this managed resource.
latestRestorableTime String: The latest time, in UTC RFC3339 format, to which a database can be restored with point-in-time restore.
listenerEndpoints List<InstanceListenerEndpoint>: Specifies the listener connection endpoint for SQL Server Always On. See endpoint below.
masterUserSecrets List<InstanceMasterUserSecret>: A block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.
replicas List<String>
resourceId String: The RDS Resource ID of this instance.
status String: The RDS instance status.
tagsAll Map<String,String>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

address string: Specifies the DNS address of the DB instance.
arn string: The ARN of the RDS instance.
endpoint string: The connection endpoint in address:port format.
engineVersionActual string: The running version of the database.
hostedZoneId string: Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
id string: The provider-assigned unique ID for this managed resource.
latestRestorableTime string: The latest time, in UTC RFC3339 format, to which a database can be restored with point-in-time restore.
listenerEndpoints InstanceListenerEndpoint[]: Specifies the listener connection endpoint for SQL Server Always On. See endpoint below.
masterUserSecrets InstanceMasterUserSecret[]: A block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.
replicas string[]
resourceId string: The RDS Resource ID of this instance.
status string: The RDS instance status.
tagsAll {[key: string]: string}: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

address str: Specifies the DNS address of the DB instance.
arn str: The ARN of the RDS instance.
endpoint str: The connection endpoint in address:port format.
engine_version_actual str: The running version of the database.
hosted_zone_id str: Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
id str: The provider-assigned unique ID for this managed resource.
latest_restorable_time str: The latest time, in UTC RFC3339 format, to which a database can be restored with point-in-time restore.
listener_endpoints Sequence[InstanceListenerEndpoint]: Specifies the listener connection endpoint for SQL Server Always On. See endpoint below.
master_user_secrets Sequence[InstanceMasterUserSecret]: A block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.
replicas Sequence[str]
resource_id str: The RDS Resource ID of this instance.
status str: The RDS instance status.
tags_all Mapping[str, str]: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

address String: Specifies the DNS address of the DB instance.
arn String: The ARN of the RDS instance.
endpoint String: The connection endpoint in address:port format.
engineVersionActual String: The running version of the database.
hostedZoneId String: Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
id String: The provider-assigned unique ID for this managed resource.
latestRestorableTime String: The latest time, in UTC RFC3339 format, to which a database can be restored with point-in-time restore.
listenerEndpoints List<Property Map>: Specifies the listener connection endpoint for SQL Server Always On. See endpoint below.
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.
replicas List<String>
resourceId String: The RDS Resource ID of this instance.
status String: The RDS instance status.
tagsAll Map<String>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Look up Existing Instance Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        address: Optional[str] = None,
        allocated_storage: Optional[int] = None,
        allow_major_version_upgrade: Optional[bool] = None,
        apply_immediately: Optional[bool] = None,
        arn: Optional[str] = None,
        auto_minor_version_upgrade: Optional[bool] = None,
        availability_zone: Optional[str] = None,
        backup_retention_period: Optional[int] = None,
        backup_window: Optional[str] = None,
        blue_green_update: Optional[InstanceBlueGreenUpdateArgs] = None,
        ca_cert_identifier: Optional[str] = None,
        character_set_name: Optional[str] = None,
        copy_tags_to_snapshot: Optional[bool] = None,
        custom_iam_instance_profile: Optional[str] = None,
        customer_owned_ip_enabled: Optional[bool] = None,
        db_name: Optional[str] = None,
        db_subnet_group_name: Optional[str] = None,
        delete_automated_backups: Optional[bool] = None,
        deletion_protection: Optional[bool] = None,
        domain: Optional[str] = None,
        domain_iam_role_name: Optional[str] = None,
        enabled_cloudwatch_logs_exports: Optional[Sequence[str]] = None,
        endpoint: Optional[str] = None,
        engine: Optional[str] = None,
        engine_version: Optional[str] = None,
        engine_version_actual: Optional[str] = None,
        final_snapshot_identifier: Optional[str] = None,
        hosted_zone_id: Optional[str] = None,
        iam_database_authentication_enabled: Optional[bool] = None,
        identifier: Optional[str] = None,
        identifier_prefix: Optional[str] = None,
        instance_class: Optional[Union[str, InstanceType]] = None,
        iops: Optional[int] = None,
        kms_key_id: Optional[str] = None,
        latest_restorable_time: Optional[str] = None,
        license_model: Optional[str] = None,
        listener_endpoints: Optional[Sequence[InstanceListenerEndpointArgs]] = None,
        maintenance_window: Optional[str] = None,
        manage_master_user_password: Optional[bool] = None,
        master_user_secret_kms_key_id: Optional[str] = None,
        master_user_secrets: Optional[Sequence[InstanceMasterUserSecretArgs]] = None,
        max_allocated_storage: Optional[int] = None,
        monitoring_interval: Optional[int] = None,
        monitoring_role_arn: Optional[str] = None,
        multi_az: Optional[bool] = None,
        name: Optional[str] = None,
        nchar_character_set_name: Optional[str] = None,
        network_type: Optional[str] = None,
        option_group_name: Optional[str] = None,
        parameter_group_name: Optional[str] = None,
        password: Optional[str] = None,
        performance_insights_enabled: Optional[bool] = None,
        performance_insights_kms_key_id: Optional[str] = None,
        performance_insights_retention_period: Optional[int] = None,
        port: Optional[int] = None,
        publicly_accessible: Optional[bool] = None,
        replica_mode: Optional[str] = None,
        replicas: Optional[Sequence[str]] = None,
        replicate_source_db: Optional[str] = None,
        resource_id: Optional[str] = None,
        restore_to_point_in_time: Optional[InstanceRestoreToPointInTimeArgs] = None,
        s3_import: Optional[InstanceS3ImportArgs] = None,
        security_group_names: Optional[Sequence[str]] = None,
        skip_final_snapshot: Optional[bool] = None,
        snapshot_identifier: Optional[str] = None,
        status: Optional[str] = None,
        storage_encrypted: Optional[bool] = None,
        storage_throughput: Optional[int] = None,
        storage_type: Optional[Union[str, StorageType]] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        timezone: Optional[str] = None,
        username: Optional[str] = None,
        vpc_security_group_ids: Optional[Sequence[str]] = None) -> Instance

func GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)

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

public static Instance get(String name, Output<String> id, InstanceState state, CustomResourceOptions options)

resources:  _:    type: aws:rds:Instance    get:      id: ${id}

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:

Address string: Specifies the DNS address of the DB instance.
AllocatedStorage int: The allocated storage in gibibytes. If max_allocated_storage is configured, this argument represents the initial storage allocation and differences from the configuration will be ignored automatically when Storage Autoscaling occurs. If replicate_source_db is set, the value is ignored during the creation of the instance.
AllowMajorVersionUpgrade bool: Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
ApplyImmediately bool: Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.
Arn string: The ARN of the RDS instance.
AutoMinorVersionUpgrade bool: Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaults to true.
AvailabilityZone string: The AZ for the RDS instance.
BackupRetentionPeriod int: The days to retain backups for. Must be between 0 and 35. Default is 0. Must be greater than 0 if the database is used as a source for a [Read Replica][instance-replication], uses low-downtime updates, or will use [RDS Blue/Green deployments][blue-green].
BackupWindow string: The daily time range (in UTC) during which automated backups are created if they are enabled. Example: "09:46-10:16". Must not overlap with maintenance_window.
BlueGreenUpdate InstanceBlueGreenUpdate: Enables low-downtime updates using [RDS Blue/Green deployments][blue-green]. See blue_green_update below
CaCertIdentifier string: The identifier of the CA certificate for the DB instance.
CharacterSetName string: The character set name to use for DB encoding in Oracle and Microsoft SQL instances (collation). This can't be changed. See Oracle Character Sets Supported in Amazon RDS or Server-Level Collation for Microsoft SQL Server for more information.
CopyTagsToSnapshot bool: Copy all Instance tags to snapshots. Default is false.
CustomIamInstanceProfile string: The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
CustomerOwnedIpEnabled bool: Indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. See CoIP for RDS on Outposts for more information.
NOTE: Removing the replicate_source_db attribute from an existing RDS Replicate database managed by the provider will promote the database to a fully standalone database.
DbName string: The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Note that this does not apply for Oracle or SQL Server engines. See the AWS documentation for more details on what applies for those engines. If you are providing an Oracle db name, it needs to be in all upper case. Cannot be specified for a replica.
DbSubnetGroupName string: Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC, or in EC2 Classic, if available. When working with read replicas, it should be specified only if the source database specifies an instance in another AWS Region. See DBSubnetGroupName in API action CreateDBInstanceReadReplica for additional read replica contraints.
DeleteAutomatedBackups bool: Specifies whether to remove automated backups immediately after the DB instance is deleted. Default is true.
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.
Domain string: The ID of the Directory Service Active Directory domain to create the instance in.
DomainIamRoleName string: The name of the IAM role to be used when making API calls to the Directory Service.
EnabledCloudwatchLogsExports List<string>: Set of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine). MySQL and MariaDB: audit, error, general, slowquery. PostgreSQL: postgresql, upgrade. MSSQL: agent , error. Oracle: alert, audit, listener, trace.
Endpoint string: The connection endpoint in address:port format.
Engine string: The database engine to use. For supported values, see the Engine parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine must match the DB cluster's engine'. 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.
EngineVersion string: The engine version to use. If auto_minor_version_upgrade is enabled, you can provide a prefix of the version such as 5.7 (for 5.7.10). The actual engine version used is returned in the attribute engine_version_actual, see Attributes Reference below. For supported values, see the EngineVersion parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine version must match the DB cluster's engine version'.
EngineVersionActual string: The running version of the database.
FinalSnapshotIdentifier string: The name of your final DB snapshot when this DB instance is deleted. Must be provided if skip_final_snapshot is set to false. The value must begin with a letter, only contain alphanumeric characters and hyphens, and not end with a hyphen or contain two consecutive hyphens. Must not be provided when deleting a read replica.
HostedZoneId string: Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
IamDatabaseAuthenticationEnabled bool: Specifies whether mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
Identifier string: The name of the RDS instance, if omitted, this provider will assign a random, unique identifier. Required if restore_to_point_in_time is specified.
IdentifierPrefix string: Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
InstanceClass string | Pulumi.Aws.Rds.InstanceType: The instance type of the RDS instance.
Iops int: The amount of provisioned IOPS. Setting this implies a storage_type of "io1". Can only be set when storage_type is "io1" or "gp3". Cannot be specified for gp3 storage if the allocated_storage value is below a per-engine threshold. See the RDS User Guide for details.
KmsKeyId string: The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.
LatestRestorableTime string: The latest time, in UTC RFC3339 format, to which a database can be restored with point-in-time restore.
LicenseModel string: (Optional, but required for some DB engines, i.e., Oracle SE1) License model information for this DB instance.
ListenerEndpoints List<InstanceListenerEndpoint>: Specifies the listener connection endpoint for SQL Server Always On. See endpoint below.
MaintenanceWindow string: The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00". See RDS Maintenance Window docs for more information.
ManageMasterUserPassword bool: Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if password is provided.
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<InstanceMasterUserSecret>: A block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.
MaxAllocatedStorage int: When configured, the upper limit to which Amazon RDS can automatically scale the storage of the DB instance. Configuring this will automatically ignore differences to allocated_storage. Must be greater than or equal to allocated_storage or 0 to disable Storage Autoscaling.
MonitoringInterval int: The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
MonitoringRoleArn string: The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
MultiAz bool: Specifies if the RDS instance is multi-AZ
Name string: The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Note that this does not apply for Oracle or SQL Server engines. See the AWS documentation for more details on what applies for those engines. If you are providing an Oracle db name, it needs to be in all upper case. Cannot be specified for a replica.
NcharCharacterSetName string: The national character set is used in the NCHAR, NVARCHAR2, and NCLOB data types for Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS.
NetworkType string: The network type of the DB instance. Valid values: IPV4, DUAL.
OptionGroupName string: Name of the DB option group to associate.
ParameterGroupName string: Name of the DB parameter group to associate.
Password string: (Required unless manage_master_user_password is set to true or unless a snapshot_identifier or replicate_source_db is provided or manage_master_user_password is set.) Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Cannot be set if manage_master_user_password is set to true.
PerformanceInsightsEnabled bool: Specifies whether Performance Insights are enabled. Defaults to false.
PerformanceInsightsKmsKeyId string: The ARN for the KMS key to encrypt Performance Insights data. When specifying performance_insights_kms_key_id, performance_insights_enabled needs to be set to true. Once KMS key is set, it can never be changed.
PerformanceInsightsRetentionPeriod int: Amount of time in days to retain Performance Insights data. Valid values are 7, 731 (2 years) or a multiple of 31. When specifying performance_insights_retention_period, performance_insights_enabled needs to be set to true. Defaults to '7'.
Port int: The port on which the DB accepts connections.
PubliclyAccessible bool: Bool to control if instance is publicly accessible. Default is false.
ReplicaMode string: Specifies whether the replica is in either mounted or open-read-only mode. This attribute is only supported by Oracle instances. Oracle replicas operate in open-read-only mode unless otherwise specified. See Working with Oracle Read Replicas for more information.
Replicas List<string>
ReplicateSourceDb string: Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate (if replicating within a single region) or ARN of the Amazon RDS Database to replicate (if replicating cross-region). Note that if you are creating a cross-region replica of an encrypted database you will also need to specify a kms_key_id. See [DB Instance Replication][instance-replication] and Working with PostgreSQL and MySQL Read Replicas for more information on using Replication.
ResourceId string: The RDS Resource ID of this instance.
RestoreToPointInTime InstanceRestoreToPointInTime: A configuration block for restoring a DB instance to an arbitrary point in time. Requires the identifier argument to be set with the name of the new DB instance to be created. See Restore To Point In Time below for details.
S3Import InstanceS3Import: Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance
SecurityGroupNames List<string>: List of DB Security Groups to associate. Only used for DB Instances on the EC2-Classic Platform.
Deprecated: With the retirement of EC2-Classic the security_group_names attribute has been deprecated and will be removed in a future version.
SkipFinalSnapshot bool: Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier. Default is false.
SnapshotIdentifier string: Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05.
Status string: The RDS instance status.
StorageEncrypted bool: Specifies whether the DB instance is encrypted. Note that if you are creating a cross-region read replica this field is ignored and you should instead declare kms_key_id with a valid ARN. The default is false if not specified.
StorageThroughput int: The storage throughput value for the DB instance. Can only be set when storage_type is "gp3". Cannot be specified if the allocated_storage value is below a per-engine threshold. See the RDS User Guide for details.
StorageType string | Pulumi.Aws.Rds.StorageType: One of "standard" (magnetic), "gp2" (general purpose SSD), "gp3" (general purpose SSD that needs iops independently) or "io1" (provisioned IOPS SSD). The default is "io1" if iops is specified, "gp2" if not.
Tags Dictionary<string, string>: A map of tags to assign to the resource. 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.
Timezone string: Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information.
Username string: (Required unless a snapshot_identifier or replicate_source_db is provided) Username for the master DB user. Cannot be specified for a replica.
VpcSecurityGroupIds List<string>: List of VPC security groups to associate.

Address string: Specifies the DNS address of the DB instance.
AllocatedStorage int: The allocated storage in gibibytes. If max_allocated_storage is configured, this argument represents the initial storage allocation and differences from the configuration will be ignored automatically when Storage Autoscaling occurs. If replicate_source_db is set, the value is ignored during the creation of the instance.
AllowMajorVersionUpgrade bool: Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
ApplyImmediately bool: Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.
Arn string: The ARN of the RDS instance.
AutoMinorVersionUpgrade bool: Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaults to true.
AvailabilityZone string: The AZ for the RDS instance.
BackupRetentionPeriod int: The days to retain backups for. Must be between 0 and 35. Default is 0. Must be greater than 0 if the database is used as a source for a [Read Replica][instance-replication], uses low-downtime updates, or will use [RDS Blue/Green deployments][blue-green].
BackupWindow string: The daily time range (in UTC) during which automated backups are created if they are enabled. Example: "09:46-10:16". Must not overlap with maintenance_window.
BlueGreenUpdate InstanceBlueGreenUpdateArgs: Enables low-downtime updates using [RDS Blue/Green deployments][blue-green]. See blue_green_update below
CaCertIdentifier string: The identifier of the CA certificate for the DB instance.
CharacterSetName string: The character set name to use for DB encoding in Oracle and Microsoft SQL instances (collation). This can't be changed. See Oracle Character Sets Supported in Amazon RDS or Server-Level Collation for Microsoft SQL Server for more information.
CopyTagsToSnapshot bool: Copy all Instance tags to snapshots. Default is false.
CustomIamInstanceProfile string: The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
CustomerOwnedIpEnabled bool: Indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. See CoIP for RDS on Outposts for more information.
NOTE: Removing the replicate_source_db attribute from an existing RDS Replicate database managed by the provider will promote the database to a fully standalone database.
DbName string: The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Note that this does not apply for Oracle or SQL Server engines. See the AWS documentation for more details on what applies for those engines. If you are providing an Oracle db name, it needs to be in all upper case. Cannot be specified for a replica.
DbSubnetGroupName string: Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC, or in EC2 Classic, if available. When working with read replicas, it should be specified only if the source database specifies an instance in another AWS Region. See DBSubnetGroupName in API action CreateDBInstanceReadReplica for additional read replica contraints.
DeleteAutomatedBackups bool: Specifies whether to remove automated backups immediately after the DB instance is deleted. Default is true.
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.
Domain string: The ID of the Directory Service Active Directory domain to create the instance in.
DomainIamRoleName string: The name of the IAM role to be used when making API calls to the Directory Service.
EnabledCloudwatchLogsExports []string: Set of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine). MySQL and MariaDB: audit, error, general, slowquery. PostgreSQL: postgresql, upgrade. MSSQL: agent , error. Oracle: alert, audit, listener, trace.
Endpoint string: The connection endpoint in address:port format.
Engine string: The database engine to use. For supported values, see the Engine parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine must match the DB cluster's engine'. 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.
EngineVersion string: The engine version to use. If auto_minor_version_upgrade is enabled, you can provide a prefix of the version such as 5.7 (for 5.7.10). The actual engine version used is returned in the attribute engine_version_actual, see Attributes Reference below. For supported values, see the EngineVersion parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine version must match the DB cluster's engine version'.
EngineVersionActual string: The running version of the database.
FinalSnapshotIdentifier string: The name of your final DB snapshot when this DB instance is deleted. Must be provided if skip_final_snapshot is set to false. The value must begin with a letter, only contain alphanumeric characters and hyphens, and not end with a hyphen or contain two consecutive hyphens. Must not be provided when deleting a read replica.
HostedZoneId string: Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
IamDatabaseAuthenticationEnabled bool: Specifies whether mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
Identifier string: The name of the RDS instance, if omitted, this provider will assign a random, unique identifier. Required if restore_to_point_in_time is specified.
IdentifierPrefix string: Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
InstanceClass string | InstanceType: The instance type of the RDS instance.
Iops int: The amount of provisioned IOPS. Setting this implies a storage_type of "io1". Can only be set when storage_type is "io1" or "gp3". Cannot be specified for gp3 storage if the allocated_storage value is below a per-engine threshold. See the RDS User Guide for details.
KmsKeyId string: The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.
LatestRestorableTime string: The latest time, in UTC RFC3339 format, to which a database can be restored with point-in-time restore.
LicenseModel string: (Optional, but required for some DB engines, i.e., Oracle SE1) License model information for this DB instance.
ListenerEndpoints []InstanceListenerEndpointArgs: Specifies the listener connection endpoint for SQL Server Always On. See endpoint below.
MaintenanceWindow string: The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00". See RDS Maintenance Window docs for more information.
ManageMasterUserPassword bool: Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if password is provided.
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 []InstanceMasterUserSecretArgs: A block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.
MaxAllocatedStorage int: When configured, the upper limit to which Amazon RDS can automatically scale the storage of the DB instance. Configuring this will automatically ignore differences to allocated_storage. Must be greater than or equal to allocated_storage or 0 to disable Storage Autoscaling.
MonitoringInterval int: The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
MonitoringRoleArn string: The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
MultiAz bool: Specifies if the RDS instance is multi-AZ
Name string: The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Note that this does not apply for Oracle or SQL Server engines. See the AWS documentation for more details on what applies for those engines. If you are providing an Oracle db name, it needs to be in all upper case. Cannot be specified for a replica.
NcharCharacterSetName string: The national character set is used in the NCHAR, NVARCHAR2, and NCLOB data types for Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS.
NetworkType string: The network type of the DB instance. Valid values: IPV4, DUAL.
OptionGroupName string: Name of the DB option group to associate.
ParameterGroupName string: Name of the DB parameter group to associate.
Password string: (Required unless manage_master_user_password is set to true or unless a snapshot_identifier or replicate_source_db is provided or manage_master_user_password is set.) Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Cannot be set if manage_master_user_password is set to true.
PerformanceInsightsEnabled bool: Specifies whether Performance Insights are enabled. Defaults to false.
PerformanceInsightsKmsKeyId string: The ARN for the KMS key to encrypt Performance Insights data. When specifying performance_insights_kms_key_id, performance_insights_enabled needs to be set to true. Once KMS key is set, it can never be changed.
PerformanceInsightsRetentionPeriod int: Amount of time in days to retain Performance Insights data. Valid values are 7, 731 (2 years) or a multiple of 31. When specifying performance_insights_retention_period, performance_insights_enabled needs to be set to true. Defaults to '7'.
Port int: The port on which the DB accepts connections.
PubliclyAccessible bool: Bool to control if instance is publicly accessible. Default is false.
ReplicaMode string: Specifies whether the replica is in either mounted or open-read-only mode. This attribute is only supported by Oracle instances. Oracle replicas operate in open-read-only mode unless otherwise specified. See Working with Oracle Read Replicas for more information.
Replicas []string
ReplicateSourceDb string: Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate (if replicating within a single region) or ARN of the Amazon RDS Database to replicate (if replicating cross-region). Note that if you are creating a cross-region replica of an encrypted database you will also need to specify a kms_key_id. See [DB Instance Replication][instance-replication] and Working with PostgreSQL and MySQL Read Replicas for more information on using Replication.
ResourceId string: The RDS Resource ID of this instance.
RestoreToPointInTime InstanceRestoreToPointInTimeArgs: A configuration block for restoring a DB instance to an arbitrary point in time. Requires the identifier argument to be set with the name of the new DB instance to be created. See Restore To Point In Time below for details.
S3Import InstanceS3ImportArgs: Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance
SecurityGroupNames []string: List of DB Security Groups to associate. Only used for DB Instances on the EC2-Classic Platform.
Deprecated: With the retirement of EC2-Classic the security_group_names attribute has been deprecated and will be removed in a future version.
SkipFinalSnapshot bool: Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier. Default is false.
SnapshotIdentifier string: Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05.
Status string: The RDS instance status.
StorageEncrypted bool: Specifies whether the DB instance is encrypted. Note that if you are creating a cross-region read replica this field is ignored and you should instead declare kms_key_id with a valid ARN. The default is false if not specified.
StorageThroughput int: The storage throughput value for the DB instance. Can only be set when storage_type is "gp3". Cannot be specified if the allocated_storage value is below a per-engine threshold. See the RDS User Guide for details.
StorageType string | StorageType: One of "standard" (magnetic), "gp2" (general purpose SSD), "gp3" (general purpose SSD that needs iops independently) or "io1" (provisioned IOPS SSD). The default is "io1" if iops is specified, "gp2" if not.
Tags map[string]string: A map of tags to assign to the resource. 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.
Timezone string: Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information.
Username string: (Required unless a snapshot_identifier or replicate_source_db is provided) Username for the master DB user. Cannot be specified for a replica.
VpcSecurityGroupIds []string: List of VPC security groups to associate.

address String: Specifies the DNS address of the DB instance.
allocatedStorage Integer: The allocated storage in gibibytes. If max_allocated_storage is configured, this argument represents the initial storage allocation and differences from the configuration will be ignored automatically when Storage Autoscaling occurs. If replicate_source_db is set, the value is ignored during the creation of the instance.
allowMajorVersionUpgrade Boolean: Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
applyImmediately Boolean: Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.
arn String: The ARN of the RDS instance.
autoMinorVersionUpgrade Boolean: Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaults to true.
availabilityZone String: The AZ for the RDS instance.
backupRetentionPeriod Integer: The days to retain backups for. Must be between 0 and 35. Default is 0. Must be greater than 0 if the database is used as a source for a [Read Replica][instance-replication], uses low-downtime updates, or will use [RDS Blue/Green deployments][blue-green].
backupWindow String: The daily time range (in UTC) during which automated backups are created if they are enabled. Example: "09:46-10:16". Must not overlap with maintenance_window.
blueGreenUpdate InstanceBlueGreenUpdate: Enables low-downtime updates using [RDS Blue/Green deployments][blue-green]. See blue_green_update below
caCertIdentifier String: The identifier of the CA certificate for the DB instance.
characterSetName String: The character set name to use for DB encoding in Oracle and Microsoft SQL instances (collation). This can't be changed. See Oracle Character Sets Supported in Amazon RDS or Server-Level Collation for Microsoft SQL Server for more information.
copyTagsToSnapshot Boolean: Copy all Instance tags to snapshots. Default is false.
customIamInstanceProfile String: The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
customerOwnedIpEnabled Boolean: Indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. See CoIP for RDS on Outposts for more information.
NOTE: Removing the replicate_source_db attribute from an existing RDS Replicate database managed by the provider will promote the database to a fully standalone database.
dbName String: The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Note that this does not apply for Oracle or SQL Server engines. See the AWS documentation for more details on what applies for those engines. If you are providing an Oracle db name, it needs to be in all upper case. Cannot be specified for a replica.
dbSubnetGroupName String: Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC, or in EC2 Classic, if available. When working with read replicas, it should be specified only if the source database specifies an instance in another AWS Region. See DBSubnetGroupName in API action CreateDBInstanceReadReplica for additional read replica contraints.
deleteAutomatedBackups Boolean: Specifies whether to remove automated backups immediately after the DB instance is deleted. Default is true.
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.
domain String: The ID of the Directory Service Active Directory domain to create the instance in.
domainIamRoleName String: The name of the IAM role to be used when making API calls to the Directory Service.
enabledCloudwatchLogsExports List<String>: Set of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine). MySQL and MariaDB: audit, error, general, slowquery. PostgreSQL: postgresql, upgrade. MSSQL: agent , error. Oracle: alert, audit, listener, trace.
endpoint String: The connection endpoint in address:port format.
engine String: The database engine to use. For supported values, see the Engine parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine must match the DB cluster's engine'. 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.
engineVersion String: The engine version to use. If auto_minor_version_upgrade is enabled, you can provide a prefix of the version such as 5.7 (for 5.7.10). The actual engine version used is returned in the attribute engine_version_actual, see Attributes Reference below. For supported values, see the EngineVersion parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine version must match the DB cluster's engine version'.
engineVersionActual String: The running version of the database.
finalSnapshotIdentifier String: The name of your final DB snapshot when this DB instance is deleted. Must be provided if skip_final_snapshot is set to false. The value must begin with a letter, only contain alphanumeric characters and hyphens, and not end with a hyphen or contain two consecutive hyphens. Must not be provided when deleting a read replica.
hostedZoneId String: Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
iamDatabaseAuthenticationEnabled Boolean: Specifies whether mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
identifier String: The name of the RDS instance, if omitted, this provider will assign a random, unique identifier. Required if restore_to_point_in_time is specified.
identifierPrefix String: Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
instanceClass String | InstanceType: The instance type of the RDS instance.
iops Integer: The amount of provisioned IOPS. Setting this implies a storage_type of "io1". Can only be set when storage_type is "io1" or "gp3". Cannot be specified for gp3 storage if the allocated_storage value is below a per-engine threshold. See the RDS User Guide for details.
kmsKeyId String: The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.
latestRestorableTime String: The latest time, in UTC RFC3339 format, to which a database can be restored with point-in-time restore.
licenseModel String: (Optional, but required for some DB engines, i.e., Oracle SE1) License model information for this DB instance.
listenerEndpoints List<InstanceListenerEndpoint>: Specifies the listener connection endpoint for SQL Server Always On. See endpoint below.
maintenanceWindow String: The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00". See RDS Maintenance Window docs for more information.
manageMasterUserPassword Boolean: Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if password is provided.
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<InstanceMasterUserSecret>: A block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.
maxAllocatedStorage Integer: When configured, the upper limit to which Amazon RDS can automatically scale the storage of the DB instance. Configuring this will automatically ignore differences to allocated_storage. Must be greater than or equal to allocated_storage or 0 to disable Storage Autoscaling.
monitoringInterval Integer: The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
monitoringRoleArn String: The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
multiAz Boolean: Specifies if the RDS instance is multi-AZ
name String: The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Note that this does not apply for Oracle or SQL Server engines. See the AWS documentation for more details on what applies for those engines. If you are providing an Oracle db name, it needs to be in all upper case. Cannot be specified for a replica.
ncharCharacterSetName String: The national character set is used in the NCHAR, NVARCHAR2, and NCLOB data types for Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS.
networkType String: The network type of the DB instance. Valid values: IPV4, DUAL.
optionGroupName String: Name of the DB option group to associate.
parameterGroupName String: Name of the DB parameter group to associate.
password String: (Required unless manage_master_user_password is set to true or unless a snapshot_identifier or replicate_source_db is provided or manage_master_user_password is set.) Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Cannot be set if manage_master_user_password is set to true.
performanceInsightsEnabled Boolean: Specifies whether Performance Insights are enabled. Defaults to false.
performanceInsightsKmsKeyId String: The ARN for the KMS key to encrypt Performance Insights data. When specifying performance_insights_kms_key_id, performance_insights_enabled needs to be set to true. Once KMS key is set, it can never be changed.
performanceInsightsRetentionPeriod Integer: Amount of time in days to retain Performance Insights data. Valid values are 7, 731 (2 years) or a multiple of 31. When specifying performance_insights_retention_period, performance_insights_enabled needs to be set to true. Defaults to '7'.
port Integer: The port on which the DB accepts connections.
publiclyAccessible Boolean: Bool to control if instance is publicly accessible. Default is false.
replicaMode String: Specifies whether the replica is in either mounted or open-read-only mode. This attribute is only supported by Oracle instances. Oracle replicas operate in open-read-only mode unless otherwise specified. See Working with Oracle Read Replicas for more information.
replicas List<String>
replicateSourceDb String: Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate (if replicating within a single region) or ARN of the Amazon RDS Database to replicate (if replicating cross-region). Note that if you are creating a cross-region replica of an encrypted database you will also need to specify a kms_key_id. See [DB Instance Replication][instance-replication] and Working with PostgreSQL and MySQL Read Replicas for more information on using Replication.
resourceId String: The RDS Resource ID of this instance.
restoreToPointInTime InstanceRestoreToPointInTime: A configuration block for restoring a DB instance to an arbitrary point in time. Requires the identifier argument to be set with the name of the new DB instance to be created. See Restore To Point In Time below for details.
s3Import InstanceS3Import: Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance
securityGroupNames List<String>: List of DB Security Groups to associate. Only used for DB Instances on the EC2-Classic Platform.
Deprecated: With the retirement of EC2-Classic the security_group_names attribute has been deprecated and will be removed in a future version.
skipFinalSnapshot Boolean: Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier. Default is false.
snapshotIdentifier String: Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05.
status String: The RDS instance status.
storageEncrypted Boolean: Specifies whether the DB instance is encrypted. Note that if you are creating a cross-region read replica this field is ignored and you should instead declare kms_key_id with a valid ARN. The default is false if not specified.
storageThroughput Integer: The storage throughput value for the DB instance. Can only be set when storage_type is "gp3". Cannot be specified if the allocated_storage value is below a per-engine threshold. See the RDS User Guide for details.
storageType String | StorageType: One of "standard" (magnetic), "gp2" (general purpose SSD), "gp3" (general purpose SSD that needs iops independently) or "io1" (provisioned IOPS SSD). The default is "io1" if iops is specified, "gp2" if not.
tags Map<String,String>: A map of tags to assign to the resource. 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.
timezone String: Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information.
username String: (Required unless a snapshot_identifier or replicate_source_db is provided) Username for the master DB user. Cannot be specified for a replica.
vpcSecurityGroupIds List<String>: List of VPC security groups to associate.

address string: Specifies the DNS address of the DB instance.
allocatedStorage number: The allocated storage in gibibytes. If max_allocated_storage is configured, this argument represents the initial storage allocation and differences from the configuration will be ignored automatically when Storage Autoscaling occurs. If replicate_source_db is set, the value is ignored during the creation of the instance.
allowMajorVersionUpgrade boolean: Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
applyImmediately boolean: Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.
arn string: The ARN of the RDS instance.
autoMinorVersionUpgrade boolean: Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaults to true.
availabilityZone string: The AZ for the RDS instance.
backupRetentionPeriod number: The days to retain backups for. Must be between 0 and 35. Default is 0. Must be greater than 0 if the database is used as a source for a [Read Replica][instance-replication], uses low-downtime updates, or will use [RDS Blue/Green deployments][blue-green].
backupWindow string: The daily time range (in UTC) during which automated backups are created if they are enabled. Example: "09:46-10:16". Must not overlap with maintenance_window.
blueGreenUpdate InstanceBlueGreenUpdate: Enables low-downtime updates using [RDS Blue/Green deployments][blue-green]. See blue_green_update below
caCertIdentifier string: The identifier of the CA certificate for the DB instance.
characterSetName string: The character set name to use for DB encoding in Oracle and Microsoft SQL instances (collation). This can't be changed. See Oracle Character Sets Supported in Amazon RDS or Server-Level Collation for Microsoft SQL Server for more information.
copyTagsToSnapshot boolean: Copy all Instance tags to snapshots. Default is false.
customIamInstanceProfile string: The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
customerOwnedIpEnabled boolean: Indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. See CoIP for RDS on Outposts for more information.
NOTE: Removing the replicate_source_db attribute from an existing RDS Replicate database managed by the provider will promote the database to a fully standalone database.
dbName string: The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Note that this does not apply for Oracle or SQL Server engines. See the AWS documentation for more details on what applies for those engines. If you are providing an Oracle db name, it needs to be in all upper case. Cannot be specified for a replica.
dbSubnetGroupName string: Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC, or in EC2 Classic, if available. When working with read replicas, it should be specified only if the source database specifies an instance in another AWS Region. See DBSubnetGroupName in API action CreateDBInstanceReadReplica for additional read replica contraints.
deleteAutomatedBackups boolean: Specifies whether to remove automated backups immediately after the DB instance is deleted. Default is true.
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.
domain string: The ID of the Directory Service Active Directory domain to create the instance in.
domainIamRoleName string: The name of the IAM role to be used when making API calls to the Directory Service.
enabledCloudwatchLogsExports string[]: Set of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine). MySQL and MariaDB: audit, error, general, slowquery. PostgreSQL: postgresql, upgrade. MSSQL: agent , error. Oracle: alert, audit, listener, trace.
endpoint string: The connection endpoint in address:port format.
engine string: The database engine to use. For supported values, see the Engine parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine must match the DB cluster's engine'. 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.
engineVersion string: The engine version to use. If auto_minor_version_upgrade is enabled, you can provide a prefix of the version such as 5.7 (for 5.7.10). The actual engine version used is returned in the attribute engine_version_actual, see Attributes Reference below. For supported values, see the EngineVersion parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine version must match the DB cluster's engine version'.
engineVersionActual string: The running version of the database.
finalSnapshotIdentifier string: The name of your final DB snapshot when this DB instance is deleted. Must be provided if skip_final_snapshot is set to false. The value must begin with a letter, only contain alphanumeric characters and hyphens, and not end with a hyphen or contain two consecutive hyphens. Must not be provided when deleting a read replica.
hostedZoneId string: Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
iamDatabaseAuthenticationEnabled boolean: Specifies whether mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
identifier string: The name of the RDS instance, if omitted, this provider will assign a random, unique identifier. Required if restore_to_point_in_time is specified.
identifierPrefix string: Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
instanceClass string | InstanceType: The instance type of the RDS instance.
iops number: The amount of provisioned IOPS. Setting this implies a storage_type of "io1". Can only be set when storage_type is "io1" or "gp3". Cannot be specified for gp3 storage if the allocated_storage value is below a per-engine threshold. See the RDS User Guide for details.
kmsKeyId string: The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.
latestRestorableTime string: The latest time, in UTC RFC3339 format, to which a database can be restored with point-in-time restore.
licenseModel string: (Optional, but required for some DB engines, i.e., Oracle SE1) License model information for this DB instance.
listenerEndpoints InstanceListenerEndpoint[]: Specifies the listener connection endpoint for SQL Server Always On. See endpoint below.
maintenanceWindow string: The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00". See RDS Maintenance Window docs for more information.
manageMasterUserPassword boolean: Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if password is provided.
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 InstanceMasterUserSecret[]: A block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.
maxAllocatedStorage number: When configured, the upper limit to which Amazon RDS can automatically scale the storage of the DB instance. Configuring this will automatically ignore differences to allocated_storage. Must be greater than or equal to allocated_storage or 0 to disable Storage Autoscaling.
monitoringInterval number: The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
monitoringRoleArn string: The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
multiAz boolean: Specifies if the RDS instance is multi-AZ
name string: The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Note that this does not apply for Oracle or SQL Server engines. See the AWS documentation for more details on what applies for those engines. If you are providing an Oracle db name, it needs to be in all upper case. Cannot be specified for a replica.
ncharCharacterSetName string: The national character set is used in the NCHAR, NVARCHAR2, and NCLOB data types for Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS.
networkType string: The network type of the DB instance. Valid values: IPV4, DUAL.
optionGroupName string: Name of the DB option group to associate.
parameterGroupName string: Name of the DB parameter group to associate.
password string: (Required unless manage_master_user_password is set to true or unless a snapshot_identifier or replicate_source_db is provided or manage_master_user_password is set.) Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Cannot be set if manage_master_user_password is set to true.
performanceInsightsEnabled boolean: Specifies whether Performance Insights are enabled. Defaults to false.
performanceInsightsKmsKeyId string: The ARN for the KMS key to encrypt Performance Insights data. When specifying performance_insights_kms_key_id, performance_insights_enabled needs to be set to true. Once KMS key is set, it can never be changed.
performanceInsightsRetentionPeriod number: Amount of time in days to retain Performance Insights data. Valid values are 7, 731 (2 years) or a multiple of 31. When specifying performance_insights_retention_period, performance_insights_enabled needs to be set to true. Defaults to '7'.
port number: The port on which the DB accepts connections.
publiclyAccessible boolean: Bool to control if instance is publicly accessible. Default is false.
replicaMode string: Specifies whether the replica is in either mounted or open-read-only mode. This attribute is only supported by Oracle instances. Oracle replicas operate in open-read-only mode unless otherwise specified. See Working with Oracle Read Replicas for more information.
replicas string[]
replicateSourceDb string: Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate (if replicating within a single region) or ARN of the Amazon RDS Database to replicate (if replicating cross-region). Note that if you are creating a cross-region replica of an encrypted database you will also need to specify a kms_key_id. See [DB Instance Replication][instance-replication] and Working with PostgreSQL and MySQL Read Replicas for more information on using Replication.
resourceId string: The RDS Resource ID of this instance.
restoreToPointInTime InstanceRestoreToPointInTime: A configuration block for restoring a DB instance to an arbitrary point in time. Requires the identifier argument to be set with the name of the new DB instance to be created. See Restore To Point In Time below for details.
s3Import InstanceS3Import: Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance
securityGroupNames string[]: List of DB Security Groups to associate. Only used for DB Instances on the EC2-Classic Platform.
Deprecated: With the retirement of EC2-Classic the security_group_names attribute has been deprecated and will be removed in a future version.
skipFinalSnapshot boolean: Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier. Default is false.
snapshotIdentifier string: Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05.
status string: The RDS instance status.
storageEncrypted boolean: Specifies whether the DB instance is encrypted. Note that if you are creating a cross-region read replica this field is ignored and you should instead declare kms_key_id with a valid ARN. The default is false if not specified.
storageThroughput number: The storage throughput value for the DB instance. Can only be set when storage_type is "gp3". Cannot be specified if the allocated_storage value is below a per-engine threshold. See the RDS User Guide for details.
storageType string | StorageType: One of "standard" (magnetic), "gp2" (general purpose SSD), "gp3" (general purpose SSD that needs iops independently) or "io1" (provisioned IOPS SSD). The default is "io1" if iops is specified, "gp2" if not.
tags {[key: string]: string}: A map of tags to assign to the resource. 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.
timezone string: Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information.
username string: (Required unless a snapshot_identifier or replicate_source_db is provided) Username for the master DB user. Cannot be specified for a replica.
vpcSecurityGroupIds string[]: List of VPC security groups to associate.

address str: Specifies the DNS address of the DB instance.
allocated_storage int: The allocated storage in gibibytes. If max_allocated_storage is configured, this argument represents the initial storage allocation and differences from the configuration will be ignored automatically when Storage Autoscaling occurs. If replicate_source_db is set, the value is ignored during the creation of the instance.
allow_major_version_upgrade bool: Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
apply_immediately bool: Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.
arn str: The ARN of the RDS instance.
auto_minor_version_upgrade bool: Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaults to true.
availability_zone str: The AZ for the RDS instance.
backup_retention_period int: The days to retain backups for. Must be between 0 and 35. Default is 0. Must be greater than 0 if the database is used as a source for a [Read Replica][instance-replication], uses low-downtime updates, or will use [RDS Blue/Green deployments][blue-green].
backup_window str: The daily time range (in UTC) during which automated backups are created if they are enabled. Example: "09:46-10:16". Must not overlap with maintenance_window.
blue_green_update InstanceBlueGreenUpdateArgs: Enables low-downtime updates using [RDS Blue/Green deployments][blue-green]. See blue_green_update below
ca_cert_identifier str: The identifier of the CA certificate for the DB instance.
character_set_name str: The character set name to use for DB encoding in Oracle and Microsoft SQL instances (collation). This can't be changed. See Oracle Character Sets Supported in Amazon RDS or Server-Level Collation for Microsoft SQL Server for more information.
copy_tags_to_snapshot bool: Copy all Instance tags to snapshots. Default is false.
custom_iam_instance_profile str: The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
customer_owned_ip_enabled bool: Indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. See CoIP for RDS on Outposts for more information.
NOTE: Removing the replicate_source_db attribute from an existing RDS Replicate database managed by the provider will promote the database to a fully standalone database.
db_name str: The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Note that this does not apply for Oracle or SQL Server engines. See the AWS documentation for more details on what applies for those engines. If you are providing an Oracle db name, it needs to be in all upper case. Cannot be specified for a replica.
db_subnet_group_name str: Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC, or in EC2 Classic, if available. When working with read replicas, it should be specified only if the source database specifies an instance in another AWS Region. See DBSubnetGroupName in API action CreateDBInstanceReadReplica for additional read replica contraints.
delete_automated_backups bool: Specifies whether to remove automated backups immediately after the DB instance is deleted. Default is true.
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.
domain str: The ID of the Directory Service Active Directory domain to create the instance in.
domain_iam_role_name str: The name of the IAM role to be used when making API calls to the Directory Service.
enabled_cloudwatch_logs_exports Sequence[str]: Set of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine). MySQL and MariaDB: audit, error, general, slowquery. PostgreSQL: postgresql, upgrade. MSSQL: agent , error. Oracle: alert, audit, listener, trace.
endpoint str: The connection endpoint in address:port format.
engine str: The database engine to use. For supported values, see the Engine parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine must match the DB cluster's engine'. 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.
engine_version str: The engine version to use. If auto_minor_version_upgrade is enabled, you can provide a prefix of the version such as 5.7 (for 5.7.10). The actual engine version used is returned in the attribute engine_version_actual, see Attributes Reference below. For supported values, see the EngineVersion parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine version must match the DB cluster's engine version'.
engine_version_actual str: The running version of the database.
final_snapshot_identifier str: The name of your final DB snapshot when this DB instance is deleted. Must be provided if skip_final_snapshot is set to false. The value must begin with a letter, only contain alphanumeric characters and hyphens, and not end with a hyphen or contain two consecutive hyphens. Must not be provided when deleting a read replica.
hosted_zone_id str: Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
iam_database_authentication_enabled bool: Specifies whether mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
identifier str: The name of the RDS instance, if omitted, this provider will assign a random, unique identifier. Required if restore_to_point_in_time is specified.
identifier_prefix str: Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
instance_class str | InstanceType: The instance type of the RDS instance.
iops int: The amount of provisioned IOPS. Setting this implies a storage_type of "io1". Can only be set when storage_type is "io1" or "gp3". Cannot be specified for gp3 storage if the allocated_storage value is below a per-engine threshold. See the RDS User Guide for details.
kms_key_id str: The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.
latest_restorable_time str: The latest time, in UTC RFC3339 format, to which a database can be restored with point-in-time restore.
license_model str: (Optional, but required for some DB engines, i.e., Oracle SE1) License model information for this DB instance.
listener_endpoints Sequence[InstanceListenerEndpointArgs]: Specifies the listener connection endpoint for SQL Server Always On. See endpoint below.
maintenance_window str: The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00". See RDS Maintenance Window docs for more information.
manage_master_user_password bool: Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if password is provided.
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[InstanceMasterUserSecretArgs]: A block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.
max_allocated_storage int: When configured, the upper limit to which Amazon RDS can automatically scale the storage of the DB instance. Configuring this will automatically ignore differences to allocated_storage. Must be greater than or equal to allocated_storage or 0 to disable Storage Autoscaling.
monitoring_interval int: The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
monitoring_role_arn str: The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
multi_az bool: Specifies if the RDS instance is multi-AZ
name str: The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Note that this does not apply for Oracle or SQL Server engines. See the AWS documentation for more details on what applies for those engines. If you are providing an Oracle db name, it needs to be in all upper case. Cannot be specified for a replica.
nchar_character_set_name str: The national character set is used in the NCHAR, NVARCHAR2, and NCLOB data types for Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS.
network_type str: The network type of the DB instance. Valid values: IPV4, DUAL.
option_group_name str: Name of the DB option group to associate.
parameter_group_name str: Name of the DB parameter group to associate.
password str: (Required unless manage_master_user_password is set to true or unless a snapshot_identifier or replicate_source_db is provided or manage_master_user_password is set.) Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Cannot be set if manage_master_user_password is set to true.
performance_insights_enabled bool: Specifies whether Performance Insights are enabled. Defaults to false.
performance_insights_kms_key_id str: The ARN for the KMS key to encrypt Performance Insights data. When specifying performance_insights_kms_key_id, performance_insights_enabled needs to be set to true. Once KMS key is set, it can never be changed.
performance_insights_retention_period int: Amount of time in days to retain Performance Insights data. Valid values are 7, 731 (2 years) or a multiple of 31. When specifying performance_insights_retention_period, performance_insights_enabled needs to be set to true. Defaults to '7'.
port int: The port on which the DB accepts connections.
publicly_accessible bool: Bool to control if instance is publicly accessible. Default is false.
replica_mode str: Specifies whether the replica is in either mounted or open-read-only mode. This attribute is only supported by Oracle instances. Oracle replicas operate in open-read-only mode unless otherwise specified. See Working with Oracle Read Replicas for more information.
replicas Sequence[str]
replicate_source_db str: Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate (if replicating within a single region) or ARN of the Amazon RDS Database to replicate (if replicating cross-region). Note that if you are creating a cross-region replica of an encrypted database you will also need to specify a kms_key_id. See [DB Instance Replication][instance-replication] and Working with PostgreSQL and MySQL Read Replicas for more information on using Replication.
resource_id str: The RDS Resource ID of this instance.
restore_to_point_in_time InstanceRestoreToPointInTimeArgs: A configuration block for restoring a DB instance to an arbitrary point in time. Requires the identifier argument to be set with the name of the new DB instance to be created. See Restore To Point In Time below for details.
s3_import InstanceS3ImportArgs: Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance
security_group_names Sequence[str]: List of DB Security Groups to associate. Only used for DB Instances on the EC2-Classic Platform.
Deprecated: With the retirement of EC2-Classic the security_group_names attribute has been deprecated and will be removed in a future version.
skip_final_snapshot bool: Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier. Default is false.
snapshot_identifier str: Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05.
status str: The RDS instance status.
storage_encrypted bool: Specifies whether the DB instance is encrypted. Note that if you are creating a cross-region read replica this field is ignored and you should instead declare kms_key_id with a valid ARN. The default is false if not specified.
storage_throughput int: The storage throughput value for the DB instance. Can only be set when storage_type is "gp3". Cannot be specified if the allocated_storage value is below a per-engine threshold. See the RDS User Guide for details.
storage_type str | StorageType: One of "standard" (magnetic), "gp2" (general purpose SSD), "gp3" (general purpose SSD that needs iops independently) or "io1" (provisioned IOPS SSD). The default is "io1" if iops is specified, "gp2" if not.
tags Mapping[str, str]: A map of tags to assign to the resource. 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.
timezone str: Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information.
username str: (Required unless a snapshot_identifier or replicate_source_db is provided) Username for the master DB user. Cannot be specified for a replica.
vpc_security_group_ids Sequence[str]: List of VPC security groups to associate.

address String: Specifies the DNS address of the DB instance.
allocatedStorage Number: The allocated storage in gibibytes. If max_allocated_storage is configured, this argument represents the initial storage allocation and differences from the configuration will be ignored automatically when Storage Autoscaling occurs. If replicate_source_db is set, the value is ignored during the creation of the instance.
allowMajorVersionUpgrade Boolean: Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
applyImmediately Boolean: Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.
arn String: The ARN of the RDS instance.
autoMinorVersionUpgrade Boolean: Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaults to true.
availabilityZone String: The AZ for the RDS instance.
backupRetentionPeriod Number: The days to retain backups for. Must be between 0 and 35. Default is 0. Must be greater than 0 if the database is used as a source for a [Read Replica][instance-replication], uses low-downtime updates, or will use [RDS Blue/Green deployments][blue-green].
backupWindow String: The daily time range (in UTC) during which automated backups are created if they are enabled. Example: "09:46-10:16". Must not overlap with maintenance_window.
blueGreenUpdate Property Map: Enables low-downtime updates using [RDS Blue/Green deployments][blue-green]. See blue_green_update below
caCertIdentifier String: The identifier of the CA certificate for the DB instance.
characterSetName String: The character set name to use for DB encoding in Oracle and Microsoft SQL instances (collation). This can't be changed. See Oracle Character Sets Supported in Amazon RDS or Server-Level Collation for Microsoft SQL Server for more information.
copyTagsToSnapshot Boolean: Copy all Instance tags to snapshots. Default is false.
customIamInstanceProfile String: The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
customerOwnedIpEnabled Boolean: Indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. See CoIP for RDS on Outposts for more information.
NOTE: Removing the replicate_source_db attribute from an existing RDS Replicate database managed by the provider will promote the database to a fully standalone database.
dbName String: The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Note that this does not apply for Oracle or SQL Server engines. See the AWS documentation for more details on what applies for those engines. If you are providing an Oracle db name, it needs to be in all upper case. Cannot be specified for a replica.
dbSubnetGroupName String: Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC, or in EC2 Classic, if available. When working with read replicas, it should be specified only if the source database specifies an instance in another AWS Region. See DBSubnetGroupName in API action CreateDBInstanceReadReplica for additional read replica contraints.
deleteAutomatedBackups Boolean: Specifies whether to remove automated backups immediately after the DB instance is deleted. Default is true.
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.
domain String: The ID of the Directory Service Active Directory domain to create the instance in.
domainIamRoleName String: The name of the IAM role to be used when making API calls to the Directory Service.
enabledCloudwatchLogsExports List<String>: Set of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine). MySQL and MariaDB: audit, error, general, slowquery. PostgreSQL: postgresql, upgrade. MSSQL: agent , error. Oracle: alert, audit, listener, trace.
endpoint String: The connection endpoint in address:port format.
engine String: The database engine to use. For supported values, see the Engine parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine must match the DB cluster's engine'. 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.
engineVersion String: The engine version to use. If auto_minor_version_upgrade is enabled, you can provide a prefix of the version such as 5.7 (for 5.7.10). The actual engine version used is returned in the attribute engine_version_actual, see Attributes Reference below. For supported values, see the EngineVersion parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine version must match the DB cluster's engine version'.
engineVersionActual String: The running version of the database.
finalSnapshotIdentifier String: The name of your final DB snapshot when this DB instance is deleted. Must be provided if skip_final_snapshot is set to false. The value must begin with a letter, only contain alphanumeric characters and hyphens, and not end with a hyphen or contain two consecutive hyphens. Must not be provided when deleting a read replica.
hostedZoneId String: Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
iamDatabaseAuthenticationEnabled Boolean: Specifies whether mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
identifier String: The name of the RDS instance, if omitted, this provider will assign a random, unique identifier. Required if restore_to_point_in_time is specified.
identifierPrefix String: Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
instanceClass String | "db.t4g.micro" | "db.t4g.small" | "db.t4g.medium" | "db.t4g.large" | "db.t4g.xlarge" | "db.t4g.2xlarge" | "db.t3.micro" | "db.t3.small" | "db.t3.medium" | "db.t3.large" | "db.t3.xlarge" | "db.t3.2xlarge" | "db.t2.micro" | "db.t2.small" | "db.t2.medium" | "db.t2.large" | "db.t2.xlarge" | "db.t2.2xlarge" | "db.m1.small" | "db.m1.medium" | "db.m1.large" | "db.m1.xlarge" | "db.m2.xlarge" | "db.m2.2xlarge" | "db.m2.4xlarge" | "db.m3.medium" | "db.m3.large" | "db.m3.xlarge" | "db.m3.2xlarge" | "db.m4.large" | "db.m4.xlarge" | "db.m4.2xlarge" | "db.m4.4xlarge" | "db.m4.10xlarge" | "db.m4.10xlarge" | "db.m5.large" | "db.m5.xlarge" | "db.m5.2xlarge" | "db.m5.4xlarge" | "db.m5.12xlarge" | "db.m5.24xlarge" | "db.m6g.large" | "db.m6g.xlarge" | "db.m6g.2xlarge" | "db.m6g.4xlarge" | "db.m6g.8xlarge" | "db.m6g.12xlarge" | "db.m6g.16xlarge" | "db.r3.large" | "db.r3.xlarge" | "db.r3.2xlarge" | "db.r3.4xlarge" | "db.r3.8xlarge" | "db.r4.large" | "db.r4.xlarge" | "db.r4.2xlarge" | "db.r4.4xlarge" | "db.r4.8xlarge" | "db.r4.16xlarge" | "db.r5.large" | "db.r5.xlarge" | "db.r5.2xlarge" | "db.r5.4xlarge" | "db.r5.12xlarge" | "db.r5.24xlarge" | "db.r6g.large" | "db.r6g.xlarge" | "db.r6g.2xlarge" | "db.r6g.4xlarge" | "db.r6g.8xlarge" | "db.r6g.12xlarge" | "db.r6g.16xlarge" | "db.x1.16xlarge" | "db.x1.32xlarge" | "db.x1e.xlarge" | "db.x1e.2xlarge" | "db.x1e.4xlarge" | "db.x1e.8xlarge" | "db.x1e.32xlarge": The instance type of the RDS instance.
iops Number: The amount of provisioned IOPS. Setting this implies a storage_type of "io1". Can only be set when storage_type is "io1" or "gp3". Cannot be specified for gp3 storage if the allocated_storage value is below a per-engine threshold. See the RDS User Guide for details.
kmsKeyId String: The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.
latestRestorableTime String: The latest time, in UTC RFC3339 format, to which a database can be restored with point-in-time restore.
licenseModel String: (Optional, but required for some DB engines, i.e., Oracle SE1) License model information for this DB instance.
listenerEndpoints List<Property Map>: Specifies the listener connection endpoint for SQL Server Always On. See endpoint below.
maintenanceWindow String: The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00". See RDS Maintenance Window docs for more information.
manageMasterUserPassword Boolean: Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if password is provided.
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.
maxAllocatedStorage Number: When configured, the upper limit to which Amazon RDS can automatically scale the storage of the DB instance. Configuring this will automatically ignore differences to allocated_storage. Must be greater than or equal to allocated_storage or 0 to disable Storage Autoscaling.
monitoringInterval Number: The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
monitoringRoleArn String: The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
multiAz Boolean: Specifies if the RDS instance is multi-AZ
name String: The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Note that this does not apply for Oracle or SQL Server engines. See the AWS documentation for more details on what applies for those engines. If you are providing an Oracle db name, it needs to be in all upper case. Cannot be specified for a replica.
ncharCharacterSetName String: The national character set is used in the NCHAR, NVARCHAR2, and NCLOB data types for Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS.
networkType String: The network type of the DB instance. Valid values: IPV4, DUAL.
optionGroupName String: Name of the DB option group to associate.
parameterGroupName String: Name of the DB parameter group to associate.
password String: (Required unless manage_master_user_password is set to true or unless a snapshot_identifier or replicate_source_db is provided or manage_master_user_password is set.) Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Cannot be set if manage_master_user_password is set to true.
performanceInsightsEnabled Boolean: Specifies whether Performance Insights are enabled. Defaults to false.
performanceInsightsKmsKeyId String: The ARN for the KMS key to encrypt Performance Insights data. When specifying performance_insights_kms_key_id, performance_insights_enabled needs to be set to true. Once KMS key is set, it can never be changed.
performanceInsightsRetentionPeriod Number: Amount of time in days to retain Performance Insights data. Valid values are 7, 731 (2 years) or a multiple of 31. When specifying performance_insights_retention_period, performance_insights_enabled needs to be set to true. Defaults to '7'.
port Number: The port on which the DB accepts connections.
publiclyAccessible Boolean: Bool to control if instance is publicly accessible. Default is false.
replicaMode String: Specifies whether the replica is in either mounted or open-read-only mode. This attribute is only supported by Oracle instances. Oracle replicas operate in open-read-only mode unless otherwise specified. See Working with Oracle Read Replicas for more information.
replicas List<String>
replicateSourceDb String: Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate (if replicating within a single region) or ARN of the Amazon RDS Database to replicate (if replicating cross-region). Note that if you are creating a cross-region replica of an encrypted database you will also need to specify a kms_key_id. See [DB Instance Replication][instance-replication] and Working with PostgreSQL and MySQL Read Replicas for more information on using Replication.
resourceId String: The RDS Resource ID of this instance.
restoreToPointInTime Property Map: A configuration block for restoring a DB instance to an arbitrary point in time. Requires the identifier argument to be set with the name of the new DB instance to be created. See Restore To Point In Time below for details.
s3Import Property Map: Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance
securityGroupNames List<String>: List of DB Security Groups to associate. Only used for DB Instances on the EC2-Classic Platform.
Deprecated: With the retirement of EC2-Classic the security_group_names attribute has been deprecated and will be removed in a future version.
skipFinalSnapshot Boolean: Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier. Default is false.
snapshotIdentifier String: Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05.
status String: The RDS instance status.
storageEncrypted Boolean: Specifies whether the DB instance is encrypted. Note that if you are creating a cross-region read replica this field is ignored and you should instead declare kms_key_id with a valid ARN. The default is false if not specified.
storageThroughput Number: The storage throughput value for the DB instance. Can only be set when storage_type is "gp3". Cannot be specified if the allocated_storage value is below a per-engine threshold. See the RDS User Guide for details.
storageType String | "standard" | "gp2" | "gp3" | "io1": One of "standard" (magnetic), "gp2" (general purpose SSD), "gp3" (general purpose SSD that needs iops independently) or "io1" (provisioned IOPS SSD). The default is "io1" if iops is specified, "gp2" if not.
tags Map<String>: A map of tags to assign to the resource. 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.
timezone String: Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information.
username String: (Required unless a snapshot_identifier or replicate_source_db is provided) Username for the master DB user. Cannot be specified for a replica.
vpcSecurityGroupIds List<String>: List of VPC security groups to associate.

Supporting Types

InstanceBlueGreenUpdate, InstanceBlueGreenUpdateArgs

Enabled bool: Enables low-downtime updates when true. Default is false.

Enabled bool: Enables low-downtime updates when true. Default is false.

enabled Boolean: Enables low-downtime updates when true. Default is false.

enabled boolean: Enables low-downtime updates when true. Default is false.

enabled bool: Enables low-downtime updates when true. Default is false.

enabled Boolean: Enables low-downtime updates when true. Default is false.

InstanceListenerEndpoint, InstanceListenerEndpointArgs

Address string: Specifies the DNS address of the DB instance.
HostedZoneId string: Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
Port int: The port on which the DB accepts connections.

Address string: Specifies the DNS address of the DB instance.
HostedZoneId string: Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
Port int: The port on which the DB accepts connections.

address String: Specifies the DNS address of the DB instance.
hostedZoneId String: Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
port Integer: The port on which the DB accepts connections.

address string: Specifies the DNS address of the DB instance.
hostedZoneId string: Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
port number: The port on which the DB accepts connections.

address str: Specifies the DNS address of the DB instance.
hosted_zone_id str: Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
port int: The port on which the DB accepts connections.

address String: Specifies the DNS address of the DB instance.
hostedZoneId String: Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
port Number: The port on which the DB accepts connections.

InstanceMasterUserSecret, InstanceMasterUserSecretArgs

KmsKeyId string: The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.
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. If creating an encrypted replica, set this to the destination KMS ARN.
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. If creating an encrypted replica, set this to the destination KMS ARN.
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. If creating an encrypted replica, set this to the destination KMS ARN.
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. If creating an encrypted replica, set this to the destination KMS ARN.
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. If creating an encrypted replica, set this to the destination KMS ARN.
secretArn String: The Amazon Resource Name (ARN) of the secret.
secretStatus String: The status of the secret. Valid Values: creating | active | rotating | impaired.

InstanceRestoreToPointInTime, InstanceRestoreToPointInTimeArgs

RestoreTime string: The date and time to restore from. Value must be a time in Universal Coordinated Time (UTC) format and must be before the latest restorable time for the DB instance. Cannot be specified with use_latest_restorable_time.
SourceDbInstanceAutomatedBackupsArn string: The ARN of the automated backup from which to restore. Required if source_db_instance_identifier or source_dbi_resource_id is not specified.
SourceDbInstanceIdentifier string: The identifier of the source DB instance from which to restore. Must match the identifier of an existing DB instance. Required if source_db_instance_automated_backups_arn or source_dbi_resource_id is not specified.
SourceDbiResourceId string: The resource ID of the source DB instance from which to restore. Required if source_db_instance_identifier or source_db_instance_automated_backups_arn is not specified.
UseLatestRestorableTime bool: A boolean value that indicates whether the DB instance is restored from the latest backup time. Defaults to false. Cannot be specified with restore_time.

RestoreTime string: The date and time to restore from. Value must be a time in Universal Coordinated Time (UTC) format and must be before the latest restorable time for the DB instance. Cannot be specified with use_latest_restorable_time.
SourceDbInstanceAutomatedBackupsArn string: The ARN of the automated backup from which to restore. Required if source_db_instance_identifier or source_dbi_resource_id is not specified.
SourceDbInstanceIdentifier string: The identifier of the source DB instance from which to restore. Must match the identifier of an existing DB instance. Required if source_db_instance_automated_backups_arn or source_dbi_resource_id is not specified.
SourceDbiResourceId string: The resource ID of the source DB instance from which to restore. Required if source_db_instance_identifier or source_db_instance_automated_backups_arn is not specified.
UseLatestRestorableTime bool: A boolean value that indicates whether the DB instance is restored from the latest backup time. Defaults to false. Cannot be specified with restore_time.

restoreTime String: The date and time to restore from. Value must be a time in Universal Coordinated Time (UTC) format and must be before the latest restorable time for the DB instance. Cannot be specified with use_latest_restorable_time.
sourceDbInstanceAutomatedBackupsArn String: The ARN of the automated backup from which to restore. Required if source_db_instance_identifier or source_dbi_resource_id is not specified.
sourceDbInstanceIdentifier String: The identifier of the source DB instance from which to restore. Must match the identifier of an existing DB instance. Required if source_db_instance_automated_backups_arn or source_dbi_resource_id is not specified.
sourceDbiResourceId String: The resource ID of the source DB instance from which to restore. Required if source_db_instance_identifier or source_db_instance_automated_backups_arn is not specified.
useLatestRestorableTime Boolean: A boolean value that indicates whether the DB instance is restored from the latest backup time. Defaults to false. Cannot be specified with restore_time.

restoreTime string: The date and time to restore from. Value must be a time in Universal Coordinated Time (UTC) format and must be before the latest restorable time for the DB instance. Cannot be specified with use_latest_restorable_time.
sourceDbInstanceAutomatedBackupsArn string: The ARN of the automated backup from which to restore. Required if source_db_instance_identifier or source_dbi_resource_id is not specified.
sourceDbInstanceIdentifier string: The identifier of the source DB instance from which to restore. Must match the identifier of an existing DB instance. Required if source_db_instance_automated_backups_arn or source_dbi_resource_id is not specified.
sourceDbiResourceId string: The resource ID of the source DB instance from which to restore. Required if source_db_instance_identifier or source_db_instance_automated_backups_arn is not specified.
useLatestRestorableTime boolean: A boolean value that indicates whether the DB instance is restored from the latest backup time. Defaults to false. Cannot be specified with restore_time.

restore_time str: The date and time to restore from. Value must be a time in Universal Coordinated Time (UTC) format and must be before the latest restorable time for the DB instance. Cannot be specified with use_latest_restorable_time.
source_db_instance_automated_backups_arn str: The ARN of the automated backup from which to restore. Required if source_db_instance_identifier or source_dbi_resource_id is not specified.
source_db_instance_identifier str: The identifier of the source DB instance from which to restore. Must match the identifier of an existing DB instance. Required if source_db_instance_automated_backups_arn or source_dbi_resource_id is not specified.
source_dbi_resource_id str: The resource ID of the source DB instance from which to restore. Required if source_db_instance_identifier or source_db_instance_automated_backups_arn is not specified.
use_latest_restorable_time bool: A boolean value that indicates whether the DB instance is restored from the latest backup time. Defaults to false. Cannot be specified with restore_time.

restoreTime String: The date and time to restore from. Value must be a time in Universal Coordinated Time (UTC) format and must be before the latest restorable time for the DB instance. Cannot be specified with use_latest_restorable_time.
sourceDbInstanceAutomatedBackupsArn String: The ARN of the automated backup from which to restore. Required if source_db_instance_identifier or source_dbi_resource_id is not specified.
sourceDbInstanceIdentifier String: The identifier of the source DB instance from which to restore. Must match the identifier of an existing DB instance. Required if source_db_instance_automated_backups_arn or source_dbi_resource_id is not specified.
sourceDbiResourceId String: The resource ID of the source DB instance from which to restore. Required if source_db_instance_identifier or source_db_instance_automated_backups_arn is not specified.
useLatestRestorableTime Boolean: A boolean value that indicates whether the DB instance is restored from the latest backup time. Defaults to false. Cannot be specified with restore_time.

InstanceS3Import, InstanceS3ImportArgs

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

This will not recreate the resource if the S3 object changes in some way. It's only used to initialize the database.

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

This will not recreate the resource if the S3 object changes in some way. It's only used to initialize the database.

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

This will not recreate the resource if the S3 object changes in some way. It's only used to initialize the database.

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

This will not recreate the resource if the S3 object changes in some way. It's only used to initialize the database.

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

This will not recreate the resource if the S3 object changes in some way. It's only used to initialize the database.

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

This will not recreate the resource if the S3 object changes in some way. It's only used to initialize the database.

bucketPrefix String

Can be blank, but is the path to your backup

InstanceType, InstanceTypeArgs

T4G_Micro: db.t4g.micro
T4G_Small: db.t4g.small
T4G_Medium: db.t4g.medium
T4G_Large: db.t4g.large
T4G_XLarge: db.t4g.xlarge
T4G_2XLarge: db.t4g.2xlarge
T3_Micro: db.t3.micro
T3_Small: db.t3.small
T3_Medium: db.t3.medium
T3_Large: db.t3.large
T3_XLarge: db.t3.xlarge
T3_2XLarge: db.t3.2xlarge
T2_Micro: db.t2.micro
T2_Small: db.t2.small
T2_Medium: db.t2.medium
T2_Large: db.t2.large
T2_XLarge: db.t2.xlarge
T2_2XLarge: db.t2.2xlarge
M1_Small: db.m1.small
M1_Medium: db.m1.medium
M1_Large: db.m1.large
M1_XLarge: db.m1.xlarge
M2_XLarge: db.m2.xlarge
M2_2XLarge: db.m2.2xlarge
M2_4XLarge: db.m2.4xlarge
M3_Medium: db.m3.medium
M3_Large: db.m3.large
M3_XLarge: db.m3.xlarge
M3_2XLarge: db.m3.2xlarge
M4_Large: db.m4.large
M4_XLarge: db.m4.xlarge
M4_2XLarge: db.m4.2xlarge
M4_4XLarge: db.m4.4xlarge
M4_10XLarge: db.m4.10xlarge
M4_16XLarge: db.m4.10xlarge
M5_Large: db.m5.large
M5_XLarge: db.m5.xlarge
M5_2XLarge: db.m5.2xlarge
M5_4XLarge: db.m5.4xlarge
M5_12XLarge: db.m5.12xlarge
M5_24XLarge: db.m5.24xlarge
M6G_Large: db.m6g.large
M6G_XLarge: db.m6g.xlarge
M6G_2XLarge: db.m6g.2xlarge
M6G_4XLarge: db.m6g.4xlarge
M6G_8XLarge: db.m6g.8xlarge
M6G_12XLarge: db.m6g.12xlarge
M6G_16XLarge: db.m6g.16xlarge
R3_Large: db.r3.large
R3_XLarge: db.r3.xlarge
R3_2XLarge: db.r3.2xlarge
R3_4XLarge: db.r3.4xlarge
R3_8XLarge: db.r3.8xlarge
R4_Large: db.r4.large
R4_XLarge: db.r4.xlarge
R4_2XLarge: db.r4.2xlarge
R4_4XLarge: db.r4.4xlarge
R4_8XLarge: db.r4.8xlarge
R4_16XLarge: db.r4.16xlarge
R5_Large: db.r5.large
R5_XLarge: db.r5.xlarge
R5_2XLarge: db.r5.2xlarge
R5_4XLarge: db.r5.4xlarge
R5_12XLarge: db.r5.12xlarge
R5_24XLarge: db.r5.24xlarge
R6G_Large: db.r6g.large
R6G_XLarge: db.r6g.xlarge
R6G_2XLarge: db.r6g.2xlarge
R6G_4XLarge: db.r6g.4xlarge
R6G_8XLarge: db.r6g.8xlarge
R6G_12XLarge: db.r6g.12xlarge
R6G_16XLarge: db.r6g.16xlarge
X1_16XLarge: db.x1.16xlarge
X1_32XLarge: db.x1.32xlarge
X1E_XLarge: db.x1e.xlarge
X1E_2XLarge: db.x1e.2xlarge
X1E_4XLarge: db.x1e.4xlarge
X1E_8XLarge: db.x1e.8xlarge
X1E_32XLarge: db.x1e.32xlarge

InstanceType_T4G_Micro: db.t4g.micro
InstanceType_T4G_Small: db.t4g.small
InstanceType_T4G_Medium: db.t4g.medium
InstanceType_T4G_Large: db.t4g.large
InstanceType_T4G_XLarge: db.t4g.xlarge
InstanceType_T4G_2XLarge: db.t4g.2xlarge
InstanceType_T3_Micro: db.t3.micro
InstanceType_T3_Small: db.t3.small
InstanceType_T3_Medium: db.t3.medium
InstanceType_T3_Large: db.t3.large
InstanceType_T3_XLarge: db.t3.xlarge
InstanceType_T3_2XLarge: db.t3.2xlarge
InstanceType_T2_Micro: db.t2.micro
InstanceType_T2_Small: db.t2.small
InstanceType_T2_Medium: db.t2.medium
InstanceType_T2_Large: db.t2.large
InstanceType_T2_XLarge: db.t2.xlarge
InstanceType_T2_2XLarge: db.t2.2xlarge
InstanceType_M1_Small: db.m1.small
InstanceType_M1_Medium: db.m1.medium
InstanceType_M1_Large: db.m1.large
InstanceType_M1_XLarge: db.m1.xlarge
InstanceType_M2_XLarge: db.m2.xlarge
InstanceType_M2_2XLarge: db.m2.2xlarge
InstanceType_M2_4XLarge: db.m2.4xlarge
InstanceType_M3_Medium: db.m3.medium
InstanceType_M3_Large: db.m3.large
InstanceType_M3_XLarge: db.m3.xlarge
InstanceType_M3_2XLarge: db.m3.2xlarge
InstanceType_M4_Large: db.m4.large
InstanceType_M4_XLarge: db.m4.xlarge
InstanceType_M4_2XLarge: db.m4.2xlarge
InstanceType_M4_4XLarge: db.m4.4xlarge
InstanceType_M4_10XLarge: db.m4.10xlarge
InstanceType_M4_16XLarge: db.m4.10xlarge
InstanceType_M5_Large: db.m5.large
InstanceType_M5_XLarge: db.m5.xlarge
InstanceType_M5_2XLarge: db.m5.2xlarge
InstanceType_M5_4XLarge: db.m5.4xlarge
InstanceType_M5_12XLarge: db.m5.12xlarge
InstanceType_M5_24XLarge: db.m5.24xlarge
InstanceType_M6G_Large: db.m6g.large
InstanceType_M6G_XLarge: db.m6g.xlarge
InstanceType_M6G_2XLarge: db.m6g.2xlarge
InstanceType_M6G_4XLarge: db.m6g.4xlarge
InstanceType_M6G_8XLarge: db.m6g.8xlarge
InstanceType_M6G_12XLarge: db.m6g.12xlarge
InstanceType_M6G_16XLarge: db.m6g.16xlarge
InstanceType_R3_Large: db.r3.large
InstanceType_R3_XLarge: db.r3.xlarge
InstanceType_R3_2XLarge: db.r3.2xlarge
InstanceType_R3_4XLarge: db.r3.4xlarge
InstanceType_R3_8XLarge: db.r3.8xlarge
InstanceType_R4_Large: db.r4.large
InstanceType_R4_XLarge: db.r4.xlarge
InstanceType_R4_2XLarge: db.r4.2xlarge
InstanceType_R4_4XLarge: db.r4.4xlarge
InstanceType_R4_8XLarge: db.r4.8xlarge
InstanceType_R4_16XLarge: db.r4.16xlarge
InstanceType_R5_Large: db.r5.large
InstanceType_R5_XLarge: db.r5.xlarge
InstanceType_R5_2XLarge: db.r5.2xlarge
InstanceType_R5_4XLarge: db.r5.4xlarge
InstanceType_R5_12XLarge: db.r5.12xlarge
InstanceType_R5_24XLarge: db.r5.24xlarge
InstanceType_R6G_Large: db.r6g.large
InstanceType_R6G_XLarge: db.r6g.xlarge
InstanceType_R6G_2XLarge: db.r6g.2xlarge
InstanceType_R6G_4XLarge: db.r6g.4xlarge
InstanceType_R6G_8XLarge: db.r6g.8xlarge
InstanceType_R6G_12XLarge: db.r6g.12xlarge
InstanceType_R6G_16XLarge: db.r6g.16xlarge
InstanceType_X1_16XLarge: db.x1.16xlarge
InstanceType_X1_32XLarge: db.x1.32xlarge
InstanceType_X1E_XLarge: db.x1e.xlarge
InstanceType_X1E_2XLarge: db.x1e.2xlarge
InstanceType_X1E_4XLarge: db.x1e.4xlarge
InstanceType_X1E_8XLarge: db.x1e.8xlarge
InstanceType_X1E_32XLarge: db.x1e.32xlarge

T4G_Micro: db.t4g.micro
T4G_Small: db.t4g.small
T4G_Medium: db.t4g.medium
T4G_Large: db.t4g.large
T4G_XLarge: db.t4g.xlarge
T4G_2XLarge: db.t4g.2xlarge
T3_Micro: db.t3.micro
T3_Small: db.t3.small
T3_Medium: db.t3.medium
T3_Large: db.t3.large
T3_XLarge: db.t3.xlarge
T3_2XLarge: db.t3.2xlarge
T2_Micro: db.t2.micro
T2_Small: db.t2.small
T2_Medium: db.t2.medium
T2_Large: db.t2.large
T2_XLarge: db.t2.xlarge
T2_2XLarge: db.t2.2xlarge
M1_Small: db.m1.small
M1_Medium: db.m1.medium
M1_Large: db.m1.large
M1_XLarge: db.m1.xlarge
M2_XLarge: db.m2.xlarge
M2_2XLarge: db.m2.2xlarge
M2_4XLarge: db.m2.4xlarge
M3_Medium: db.m3.medium
M3_Large: db.m3.large
M3_XLarge: db.m3.xlarge
M3_2XLarge: db.m3.2xlarge
M4_Large: db.m4.large
M4_XLarge: db.m4.xlarge
M4_2XLarge: db.m4.2xlarge
M4_4XLarge: db.m4.4xlarge
M4_10XLarge: db.m4.10xlarge
M4_16XLarge: db.m4.10xlarge
M5_Large: db.m5.large
M5_XLarge: db.m5.xlarge
M5_2XLarge: db.m5.2xlarge
M5_4XLarge: db.m5.4xlarge
M5_12XLarge: db.m5.12xlarge
M5_24XLarge: db.m5.24xlarge
M6G_Large: db.m6g.large
M6G_XLarge: db.m6g.xlarge
M6G_2XLarge: db.m6g.2xlarge
M6G_4XLarge: db.m6g.4xlarge
M6G_8XLarge: db.m6g.8xlarge
M6G_12XLarge: db.m6g.12xlarge
M6G_16XLarge: db.m6g.16xlarge
R3_Large: db.r3.large
R3_XLarge: db.r3.xlarge
R3_2XLarge: db.r3.2xlarge
R3_4XLarge: db.r3.4xlarge
R3_8XLarge: db.r3.8xlarge
R4_Large: db.r4.large
R4_XLarge: db.r4.xlarge
R4_2XLarge: db.r4.2xlarge
R4_4XLarge: db.r4.4xlarge
R4_8XLarge: db.r4.8xlarge
R4_16XLarge: db.r4.16xlarge
R5_Large: db.r5.large
R5_XLarge: db.r5.xlarge
R5_2XLarge: db.r5.2xlarge
R5_4XLarge: db.r5.4xlarge
R5_12XLarge: db.r5.12xlarge
R5_24XLarge: db.r5.24xlarge
R6G_Large: db.r6g.large
R6G_XLarge: db.r6g.xlarge
R6G_2XLarge: db.r6g.2xlarge
R6G_4XLarge: db.r6g.4xlarge
R6G_8XLarge: db.r6g.8xlarge
R6G_12XLarge: db.r6g.12xlarge
R6G_16XLarge: db.r6g.16xlarge
X1_16XLarge: db.x1.16xlarge
X1_32XLarge: db.x1.32xlarge
X1E_XLarge: db.x1e.xlarge
X1E_2XLarge: db.x1e.2xlarge
X1E_4XLarge: db.x1e.4xlarge
X1E_8XLarge: db.x1e.8xlarge
X1E_32XLarge: db.x1e.32xlarge

T4G_Micro: db.t4g.micro
T4G_Small: db.t4g.small
T4G_Medium: db.t4g.medium
T4G_Large: db.t4g.large
T4G_XLarge: db.t4g.xlarge
T4G_2XLarge: db.t4g.2xlarge
T3_Micro: db.t3.micro
T3_Small: db.t3.small
T3_Medium: db.t3.medium
T3_Large: db.t3.large
T3_XLarge: db.t3.xlarge
T3_2XLarge: db.t3.2xlarge
T2_Micro: db.t2.micro
T2_Small: db.t2.small
T2_Medium: db.t2.medium
T2_Large: db.t2.large
T2_XLarge: db.t2.xlarge
T2_2XLarge: db.t2.2xlarge
M1_Small: db.m1.small
M1_Medium: db.m1.medium
M1_Large: db.m1.large
M1_XLarge: db.m1.xlarge
M2_XLarge: db.m2.xlarge
M2_2XLarge: db.m2.2xlarge
M2_4XLarge: db.m2.4xlarge
M3_Medium: db.m3.medium
M3_Large: db.m3.large
M3_XLarge: db.m3.xlarge
M3_2XLarge: db.m3.2xlarge
M4_Large: db.m4.large
M4_XLarge: db.m4.xlarge
M4_2XLarge: db.m4.2xlarge
M4_4XLarge: db.m4.4xlarge
M4_10XLarge: db.m4.10xlarge
M4_16XLarge: db.m4.10xlarge
M5_Large: db.m5.large
M5_XLarge: db.m5.xlarge
M5_2XLarge: db.m5.2xlarge
M5_4XLarge: db.m5.4xlarge
M5_12XLarge: db.m5.12xlarge
M5_24XLarge: db.m5.24xlarge
M6G_Large: db.m6g.large
M6G_XLarge: db.m6g.xlarge
M6G_2XLarge: db.m6g.2xlarge
M6G_4XLarge: db.m6g.4xlarge
M6G_8XLarge: db.m6g.8xlarge
M6G_12XLarge: db.m6g.12xlarge
M6G_16XLarge: db.m6g.16xlarge
R3_Large: db.r3.large
R3_XLarge: db.r3.xlarge
R3_2XLarge: db.r3.2xlarge
R3_4XLarge: db.r3.4xlarge
R3_8XLarge: db.r3.8xlarge
R4_Large: db.r4.large
R4_XLarge: db.r4.xlarge
R4_2XLarge: db.r4.2xlarge
R4_4XLarge: db.r4.4xlarge
R4_8XLarge: db.r4.8xlarge
R4_16XLarge: db.r4.16xlarge
R5_Large: db.r5.large
R5_XLarge: db.r5.xlarge
R5_2XLarge: db.r5.2xlarge
R5_4XLarge: db.r5.4xlarge
R5_12XLarge: db.r5.12xlarge
R5_24XLarge: db.r5.24xlarge
R6G_Large: db.r6g.large
R6G_XLarge: db.r6g.xlarge
R6G_2XLarge: db.r6g.2xlarge
R6G_4XLarge: db.r6g.4xlarge
R6G_8XLarge: db.r6g.8xlarge
R6G_12XLarge: db.r6g.12xlarge
R6G_16XLarge: db.r6g.16xlarge
X1_16XLarge: db.x1.16xlarge
X1_32XLarge: db.x1.32xlarge
X1E_XLarge: db.x1e.xlarge
X1E_2XLarge: db.x1e.2xlarge
X1E_4XLarge: db.x1e.4xlarge
X1E_8XLarge: db.x1e.8xlarge
X1E_32XLarge: db.x1e.32xlarge

T4_G_MICRO: db.t4g.micro
T4_G_SMALL: db.t4g.small
T4_G_MEDIUM: db.t4g.medium
T4_G_LARGE: db.t4g.large
T4_G_X_LARGE: db.t4g.xlarge
T4_G_2_X_LARGE: db.t4g.2xlarge
T3_MICRO: db.t3.micro
T3_SMALL: db.t3.small
T3_MEDIUM: db.t3.medium
T3_LARGE: db.t3.large
T3_X_LARGE: db.t3.xlarge
T3_2_X_LARGE: db.t3.2xlarge
T2_MICRO: db.t2.micro
T2_SMALL: db.t2.small
T2_MEDIUM: db.t2.medium
T2_LARGE: db.t2.large
T2_X_LARGE: db.t2.xlarge
T2_2_X_LARGE: db.t2.2xlarge
M1_SMALL: db.m1.small
M1_MEDIUM: db.m1.medium
M1_LARGE: db.m1.large
M1_X_LARGE: db.m1.xlarge
M2_X_LARGE: db.m2.xlarge
M2_2_X_LARGE: db.m2.2xlarge
M2_4_X_LARGE: db.m2.4xlarge
M3_MEDIUM: db.m3.medium
M3_LARGE: db.m3.large
M3_X_LARGE: db.m3.xlarge
M3_2_X_LARGE: db.m3.2xlarge
M4_LARGE: db.m4.large
M4_X_LARGE: db.m4.xlarge
M4_2_X_LARGE: db.m4.2xlarge
M4_4_X_LARGE: db.m4.4xlarge
M4_10_X_LARGE: db.m4.10xlarge
M4_16_X_LARGE: db.m4.10xlarge
M5_LARGE: db.m5.large
M5_X_LARGE: db.m5.xlarge
M5_2_X_LARGE: db.m5.2xlarge
M5_4_X_LARGE: db.m5.4xlarge
M5_12_X_LARGE: db.m5.12xlarge
M5_24_X_LARGE: db.m5.24xlarge
M6_G_LARGE: db.m6g.large
M6_G_X_LARGE: db.m6g.xlarge
M6_G_2_X_LARGE: db.m6g.2xlarge
M6_G_4_X_LARGE: db.m6g.4xlarge
M6_G_8_X_LARGE: db.m6g.8xlarge
M6_G_12_X_LARGE: db.m6g.12xlarge
M6_G_16_X_LARGE: db.m6g.16xlarge
R3_LARGE: db.r3.large
R3_X_LARGE: db.r3.xlarge
R3_2_X_LARGE: db.r3.2xlarge
R3_4_X_LARGE: db.r3.4xlarge
R3_8_X_LARGE: db.r3.8xlarge
R4_LARGE: db.r4.large
R4_X_LARGE: db.r4.xlarge
R4_2_X_LARGE: db.r4.2xlarge
R4_4_X_LARGE: db.r4.4xlarge
R4_8_X_LARGE: db.r4.8xlarge
R4_16_X_LARGE: db.r4.16xlarge
R5_LARGE: db.r5.large
R5_X_LARGE: db.r5.xlarge
R5_2_X_LARGE: db.r5.2xlarge
R5_4_X_LARGE: db.r5.4xlarge
R5_12_X_LARGE: db.r5.12xlarge
R5_24_X_LARGE: db.r5.24xlarge
R6_G_LARGE: db.r6g.large
R6_G_X_LARGE: db.r6g.xlarge
R6_G_2_X_LARGE: db.r6g.2xlarge
R6_G_4_X_LARGE: db.r6g.4xlarge
R6_G_8_X_LARGE: db.r6g.8xlarge
R6_G_12_X_LARGE: db.r6g.12xlarge
R6_G_16_X_LARGE: db.r6g.16xlarge
X1_16_X_LARGE: db.x1.16xlarge
X1_32_X_LARGE: db.x1.32xlarge
X1_E_X_LARGE: db.x1e.xlarge
X1_E_2_X_LARGE: db.x1e.2xlarge
X1_E_4_X_LARGE: db.x1e.4xlarge
X1_E_8_X_LARGE: db.x1e.8xlarge
X1_E_32_X_LARGE: db.x1e.32xlarge

"db.t4g.micro": db.t4g.micro
"db.t4g.small": db.t4g.small
"db.t4g.medium": db.t4g.medium
"db.t4g.large": db.t4g.large
"db.t4g.xlarge": db.t4g.xlarge
"db.t4g.2xlarge": db.t4g.2xlarge
"db.t3.micro": db.t3.micro
"db.t3.small": db.t3.small
"db.t3.medium": db.t3.medium
"db.t3.large": db.t3.large
"db.t3.xlarge": db.t3.xlarge
"db.t3.2xlarge": db.t3.2xlarge
"db.t2.micro": db.t2.micro
"db.t2.small": db.t2.small
"db.t2.medium": db.t2.medium
"db.t2.large": db.t2.large
"db.t2.xlarge": db.t2.xlarge
"db.t2.2xlarge": db.t2.2xlarge
"db.m1.small": db.m1.small
"db.m1.medium": db.m1.medium
"db.m1.large": db.m1.large
"db.m1.xlarge": db.m1.xlarge
"db.m2.xlarge": db.m2.xlarge
"db.m2.2xlarge": db.m2.2xlarge
"db.m2.4xlarge": db.m2.4xlarge
"db.m3.medium": db.m3.medium
"db.m3.large": db.m3.large
"db.m3.xlarge": db.m3.xlarge
"db.m3.2xlarge": db.m3.2xlarge
"db.m4.large": db.m4.large
"db.m4.xlarge": db.m4.xlarge
"db.m4.2xlarge": db.m4.2xlarge
"db.m4.4xlarge": db.m4.4xlarge
"db.m4.10xlarge": db.m4.10xlarge
"db.m4.10xlarge": db.m4.10xlarge
"db.m5.large": db.m5.large
"db.m5.xlarge": db.m5.xlarge
"db.m5.2xlarge": db.m5.2xlarge
"db.m5.4xlarge": db.m5.4xlarge
"db.m5.12xlarge": db.m5.12xlarge
"db.m5.24xlarge": db.m5.24xlarge
"db.m6g.large": db.m6g.large
"db.m6g.xlarge": db.m6g.xlarge
"db.m6g.2xlarge": db.m6g.2xlarge
"db.m6g.4xlarge": db.m6g.4xlarge
"db.m6g.8xlarge": db.m6g.8xlarge
"db.m6g.12xlarge": db.m6g.12xlarge
"db.m6g.16xlarge": db.m6g.16xlarge
"db.r3.large": db.r3.large
"db.r3.xlarge": db.r3.xlarge
"db.r3.2xlarge": db.r3.2xlarge
"db.r3.4xlarge": db.r3.4xlarge
"db.r3.8xlarge": db.r3.8xlarge
"db.r4.large": db.r4.large
"db.r4.xlarge": db.r4.xlarge
"db.r4.2xlarge": db.r4.2xlarge
"db.r4.4xlarge": db.r4.4xlarge
"db.r4.8xlarge": db.r4.8xlarge
"db.r4.16xlarge": db.r4.16xlarge
"db.r5.large": db.r5.large
"db.r5.xlarge": db.r5.xlarge
"db.r5.2xlarge": db.r5.2xlarge
"db.r5.4xlarge": db.r5.4xlarge
"db.r5.12xlarge": db.r5.12xlarge
"db.r5.24xlarge": db.r5.24xlarge
"db.r6g.large": db.r6g.large
"db.r6g.xlarge": db.r6g.xlarge
"db.r6g.2xlarge": db.r6g.2xlarge
"db.r6g.4xlarge": db.r6g.4xlarge
"db.r6g.8xlarge": db.r6g.8xlarge
"db.r6g.12xlarge": db.r6g.12xlarge
"db.r6g.16xlarge": db.r6g.16xlarge
"db.x1.16xlarge": db.x1.16xlarge
"db.x1.32xlarge": db.x1.32xlarge
"db.x1e.xlarge": db.x1e.xlarge
"db.x1e.2xlarge": db.x1e.2xlarge
"db.x1e.4xlarge": db.x1e.4xlarge
"db.x1e.8xlarge": db.x1e.8xlarge
"db.x1e.32xlarge": db.x1e.32xlarge

StorageType, StorageTypeArgs

Standard: standard
GP2: gp2
GP3: gp3
IO1: io1

StorageTypeStandard: standard
StorageTypeGP2: gp2
StorageTypeGP3: gp3
StorageTypeIO1: io1

Standard: standard
GP2: gp2
GP3: gp3
IO1: io1

Standard: standard
GP2: gp2
GP3: gp3
IO1: io1

STANDARD: standard
GP2: gp2
GP3: gp3
IO1: io1

"standard": standard
"gp2": gp2
"gp3": gp3
"io1": io1

Import

DB Instances can be imported using the identifier, e.g.,

 $ pulumi import aws:rds/instance:Instance default mydb-rds-instance

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

Package Details

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

Viewing docs for AWS v5.43.0 (Older version)
published on Tuesday, Mar 10, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-aws

aws.rds.Instance

On this page

On this page

RDS Instance Class Types

Low-Downtime Updates

Example Usage

Basic Usage

RDS Custom for Oracle Usage with Replica

Storage Autoscaling

Managed Master Passwords via Secrets Manager, default KMS Key

Managed Master Passwords via Secrets Manager, specific KMS Key

Create Instance Resource

Constructor syntax

Parameters

Constructor example

Instance Resource Properties

Inputs

Outputs

Look up Existing Instance Resource

Supporting Types

InstanceBlueGreenUpdate, InstanceBlueGreenUpdateArgs

InstanceListenerEndpoint, InstanceListenerEndpointArgs

InstanceMasterUserSecret, InstanceMasterUserSecretArgs

InstanceRestoreToPointInTime, InstanceRestoreToPointInTimeArgs

InstanceS3Import, InstanceS3ImportArgs

InstanceType, InstanceTypeArgs

StorageType, StorageTypeArgs

Import

Package Details

On this page

On this page