Try AWS Native preview for resources not in the classic version.
aws.rds.Instance
Explore with Pulumi AI
Try AWS Native preview for resources not in the classic version.
Provides an RDS instance resource. A DB instance is an isolated database environment in the cloud. A DB instance can contain multiple user-created databases.
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/v6/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 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")
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",
});
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
Coming soon!
Coming soon!
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());
}
}
Coming soon!
Coming soon!
resources:
default:
type: aws:rds:Instance
properties:
allocatedStorage: 50
autoMinorVersionUpgrade: false
# Custom for Oracle does 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
RDS Custom for SQL Server
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/v6/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-sqlserver = RdsFunctions.getOrderableDbInstance(GetOrderableDbInstanceArgs.builder()
.engine("custom-sqlserver-se")
.engineVersion("115.00.4249.2.cev1")
.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 example = new Instance("example", InstanceArgs.builder()
.allocatedStorage(500)
.autoMinorVersionUpgrade(false)
.customIamInstanceProfile("AWSRDSCustomSQLServerInstanceRole")
.backupRetentionPeriod(7)
.dbSubnetGroupName(local.db_subnet_group_name())
.engine(custom_sqlserver.engine())
.engineVersion(custom_sqlserver.engineVersion())
.identifier("sql-instance-demo")
.instanceClass(custom_sqlserver.instanceClass())
.kmsKeyId(byId.applyValue(getKeyResult -> getKeyResult.arn()))
.multiAz(false)
.password("avoid-plaintext-passwords")
.username("test")
.timeouts(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.build());
}
}
import pulumi
import pulumi_aws as aws
example = aws.rds.Instance("example",
allocated_storage=50,
max_allocated_storage=100)
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.rds.Instance("example", {
allocatedStorage: 50,
maxAllocatedStorage: 100,
});
resources:
example:
type: aws:rds:Instance
properties:
allocatedStorage: 500
autoMinorVersionUpgrade: false
# Custom for SQL Server does not support minor version upgrades
customIamInstanceProfile: AWSRDSCustomSQLServerInstanceRole
# Instance profile is required for Custom for SQL Server. See: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-sqlserver.html#custom-setup-sqlserver.iam
backupRetentionPeriod: 7
dbSubnetGroupName: ${local.db_subnet_group_name}
engine: ${["custom-sqlserver"].engine}
engineVersion: ${["custom-sqlserver"].engineVersion}
identifier: sql-instance-demo
instanceClass: ${["custom-sqlserver"].instanceClass}
kmsKeyId: ${byId.arn}
multiAz: false
# Custom for SQL Server does not support multi-az
password: avoid-plaintext-passwords
username: test
timeouts:
- create: 3h
delete: 3h
update: 3h
variables:
custom-sqlserver:
fn::invoke:
Function: aws:rds:getOrderableDbInstance
Arguments:
engine: custom-sqlserver-se
engineVersion: 115.00.4249.2.cev1
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/v6/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 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")
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",
});
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/v6/go/aws/kms"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/rds"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := kms.NewKey(ctx, "example", &kms.KeyArgs{
Description: pulumi.String("Example KMS Key"),
})
if err != nil {
return err
}
_, err = rds.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 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")
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",
});
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
Coming soon!
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());
}
}
Coming soon!
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
new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);
@overload
def Instance(resource_name: str,
opts: Optional[ResourceOptions] = 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_target: Optional[str] = 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,
instance_class: Optional[Union[str, InstanceType]] = 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,
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)
@overload
def Instance(resource_name: str,
args: InstanceArgs,
opts: Optional[ResourceOptions] = 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.
- 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.
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
The Instance resource accepts the following input properties:
- Instance
Class string | Pulumi.Aws. Rds. Instance Type 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. Ifreplicate_source_db
is set, the value is ignored during the creation of the instance.- Allow
Major boolVersion Upgrade 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 boolVersion Upgrade Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaults to true.
- Availability
Zone string The AZ for the RDS instance.
- Backup
Retention intPeriod The days to retain backups for. Must be between
0
and35
. Default is0
. Must be greater than0
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
Target string Specifies where automated backups and manual snapshots are stored. Possible values are
region
(default) andoutposts
. See Working with Amazon RDS on AWS Outposts for more information.- Backup
Window 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
.- Blue
Green InstanceUpdate Blue Green Update Enables low-downtime updates using [RDS Blue/Green deployments][blue-green]. See blue_green_update below
- Ca
Cert stringIdentifier The identifier of the CA certificate for the DB instance.
- Character
Set stringName 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.
- bool
Copy all Instance
tags
to snapshots. Default isfalse
.- Custom
Iam stringInstance Profile The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
- Customer
Owned boolIp Enabled 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 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.
- Db
Subnet stringGroup Name 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 boolBackups 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 isfalse
.- Domain string
The ID of the Directory Service Active Directory domain to create the instance in.
- Domain
Iam stringRole Name The name of the IAM role to be used when making API calls to the Directory Service.
- Enabled
Cloudwatch List<string>Logs Exports 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.
- Engine
Version string The engine version to use. If
auto_minor_version_upgrade
is enabled, you can provide a prefix of the version such as5.7
(for5.7.10
). The actual engine version used is returned in the attributeengine_version_actual
, see Attribute 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 stringIdentifier The name of your final DB snapshot when this DB instance is deleted. Must be provided if
skip_final_snapshot
is set tofalse
. 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 boolAuthentication Enabled 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.- Identifier
Prefix 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 theallocated_storage
value is below a per-engine
threshold. See the RDS User Guide for details.- Kms
Key stringId The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.
- License
Model string (Optional, but required for some DB engines, i.e., Oracle SE1) License model information for this DB instance.
- Maintenance
Window 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.
- Manage
Master boolUser Password Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if
password
is provided.- Master
User stringSecret Kms Key Id 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 intStorage 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 toallocated_storage
or0
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 stringArn 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 string
This property has been deprecated. Please use 'dbName' instead.
- Nchar
Character stringSet Name 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 string The network type of the DB instance. Valid values:
IPV4
,DUAL
.- Option
Group stringName Name of the DB option group to associate.
- Parameter
Group stringName Name of the DB parameter group to associate.
- Password string
(Required unless
manage_master_user_password
is set to true or unless asnapshot_identifier
orreplicate_source_db
is provided ormanage_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 ifmanage_master_user_password
is set totrue
.- Performance
Insights boolEnabled Specifies whether Performance Insights are enabled. Defaults to false.
- Performance
Insights stringKms Key Id 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 intRetention Period Amount of time in days to retain Performance Insights data. Valid values are
7
,731
(2 years) or a multiple of31
. When specifyingperformance_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 string Specifies whether the replica is in either
mounted
oropen-read-only
mode. This attribute is only supported by Oracle instances. Oracle replicas operate inopen-read-only
mode unless otherwise specified. See Working with Oracle Read Replicas for more information.- Replicate
Source stringDb 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 akms_key_id
. See [DB Instance Replication][instance-replication] and Working with PostgreSQL and MySQL Read Replicas for more information on using Replication.- Restore
To InstancePoint In Time Restore To Point In Time 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
Instance
S3Import Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance
- Skip
Final boolSnapshot 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 isfalse
.- Snapshot
Identifier 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.
- 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 isfalse
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 theallocated_storage
value is below a per-engine
threshold. See the RDS User Guide for details.- Storage
Type string | Pulumi.Aws. Rds. Storage Type 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" ifiops
is specified, "gp2" if not.- 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. Thetimezone
can only be set on creation. See MSSQL User Guide for more information.- Username string
(Required unless a
snapshot_identifier
orreplicate_source_db
is provided) Username for the master DB user. Cannot be specified for a replica.- Vpc
Security List<string>Group Ids List of VPC security groups to associate.
- Instance
Class string | 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. Ifreplicate_source_db
is set, the value is ignored during the creation of the instance.- Allow
Major boolVersion Upgrade 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 boolVersion Upgrade Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaults to true.
- Availability
Zone string The AZ for the RDS instance.
- Backup
Retention intPeriod The days to retain backups for. Must be between
0
and35
. Default is0
. Must be greater than0
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
Target string Specifies where automated backups and manual snapshots are stored. Possible values are
region
(default) andoutposts
. See Working with Amazon RDS on AWS Outposts for more information.- Backup
Window 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
.- Blue
Green InstanceUpdate Blue Green Update Args Enables low-downtime updates using [RDS Blue/Green deployments][blue-green]. See blue_green_update below
- Ca
Cert stringIdentifier The identifier of the CA certificate for the DB instance.
- Character
Set stringName 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.
- bool
Copy all Instance
tags
to snapshots. Default isfalse
.- Custom
Iam stringInstance Profile The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
- Customer
Owned boolIp Enabled 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 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.
- Db
Subnet stringGroup Name 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 boolBackups 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 isfalse
.- Domain string
The ID of the Directory Service Active Directory domain to create the instance in.
- Domain
Iam stringRole Name The name of the IAM role to be used when making API calls to the Directory Service.
- Enabled
Cloudwatch []stringLogs Exports 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.
- Engine
Version string The engine version to use. If
auto_minor_version_upgrade
is enabled, you can provide a prefix of the version such as5.7
(for5.7.10
). The actual engine version used is returned in the attributeengine_version_actual
, see Attribute 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 stringIdentifier The name of your final DB snapshot when this DB instance is deleted. Must be provided if
skip_final_snapshot
is set tofalse
. 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 boolAuthentication Enabled 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.- Identifier
Prefix 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 theallocated_storage
value is below a per-engine
threshold. See the RDS User Guide for details.- Kms
Key stringId The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.
- License
Model string (Optional, but required for some DB engines, i.e., Oracle SE1) License model information for this DB instance.
- Maintenance
Window 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.
- Manage
Master boolUser Password Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if
password
is provided.- Master
User stringSecret Kms Key Id 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 intStorage 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 toallocated_storage
or0
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 stringArn 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 string
This property has been deprecated. Please use 'dbName' instead.
- Nchar
Character stringSet Name 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 string The network type of the DB instance. Valid values:
IPV4
,DUAL
.- Option
Group stringName Name of the DB option group to associate.
- Parameter
Group stringName Name of the DB parameter group to associate.
- Password string
(Required unless
manage_master_user_password
is set to true or unless asnapshot_identifier
orreplicate_source_db
is provided ormanage_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 ifmanage_master_user_password
is set totrue
.- Performance
Insights boolEnabled Specifies whether Performance Insights are enabled. Defaults to false.
- Performance
Insights stringKms Key Id 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 intRetention Period Amount of time in days to retain Performance Insights data. Valid values are
7
,731
(2 years) or a multiple of31
. When specifyingperformance_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 string Specifies whether the replica is in either
mounted
oropen-read-only
mode. This attribute is only supported by Oracle instances. Oracle replicas operate inopen-read-only
mode unless otherwise specified. See Working with Oracle Read Replicas for more information.- Replicate
Source stringDb 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 akms_key_id
. See [DB Instance Replication][instance-replication] and Working with PostgreSQL and MySQL Read Replicas for more information on using Replication.- Restore
To InstancePoint In Time Restore To Point In Time Args 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
Instance
S3Import Args Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance
- Skip
Final boolSnapshot 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 isfalse
.- Snapshot
Identifier 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.
- 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 isfalse
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 theallocated_storage
value is below a per-engine
threshold. See the RDS User Guide for details.- Storage
Type 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" ifiops
is specified, "gp2" if not.- 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. Thetimezone
can only be set on creation. See MSSQL User Guide for more information.- Username string
(Required unless a
snapshot_identifier
orreplicate_source_db
is provided) Username for the master DB user. Cannot be specified for a replica.- Vpc
Security []stringGroup Ids List of VPC security groups to associate.
- instance
Class String | InstanceType The instance type of the RDS instance.
- allocated
Storage 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. Ifreplicate_source_db
is set, the value is ignored during the creation of the instance.- allow
Major BooleanVersion Upgrade 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 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.- auto
Minor BooleanVersion Upgrade Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaults to true.
- availability
Zone String The AZ for the RDS instance.
- backup
Retention IntegerPeriod The days to retain backups for. Must be between
0
and35
. Default is0
. Must be greater than0
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
Target String Specifies where automated backups and manual snapshots are stored. Possible values are
region
(default) andoutposts
. See Working with Amazon RDS on AWS Outposts for more information.- backup
Window 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
.- blue
Green InstanceUpdate Blue Green Update Enables low-downtime updates using [RDS Blue/Green deployments][blue-green]. See blue_green_update below
- ca
Cert StringIdentifier The identifier of the CA certificate for the DB instance.
- character
Set StringName 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.
- Boolean
Copy all Instance
tags
to snapshots. Default isfalse
.- custom
Iam StringInstance Profile The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
- customer
Owned BooleanIp Enabled 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 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.
- db
Subnet StringGroup Name 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 BooleanBackups Specifies whether to remove automated backups immediately after the DB instance is deleted. Default is
true
.- deletion
Protection 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 isfalse
.- domain String
The ID of the Directory Service Active Directory domain to create the instance in.
- domain
Iam StringRole Name The name of the IAM role to be used when making API calls to the Directory Service.
- enabled
Cloudwatch List<String>Logs Exports 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.
- engine
Version String The engine version to use. If
auto_minor_version_upgrade
is enabled, you can provide a prefix of the version such as5.7
(for5.7.10
). The actual engine version used is returned in the attributeengine_version_actual
, see Attribute 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 StringIdentifier The name of your final DB snapshot when this DB instance is deleted. Must be provided if
skip_final_snapshot
is set tofalse
. 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 BooleanAuthentication Enabled 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.- identifier
Prefix 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 theallocated_storage
value is below a per-engine
threshold. See the RDS User Guide for details.- kms
Key StringId The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.
- license
Model String (Optional, but required for some DB engines, i.e., Oracle SE1) License model information for this DB instance.
- maintenance
Window 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.
- manage
Master BooleanUser Password Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if
password
is provided.- master
User StringSecret Kms Key Id 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 IntegerStorage 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 toallocated_storage
or0
to disable Storage Autoscaling.- monitoring
Interval 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.
- monitoring
Role StringArn 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 Boolean Specifies if the RDS instance is multi-AZ
- name String
This property has been deprecated. Please use 'dbName' instead.
- nchar
Character StringSet Name 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 String The network type of the DB instance. Valid values:
IPV4
,DUAL
.- option
Group StringName Name of the DB option group to associate.
- parameter
Group StringName Name of the DB parameter group to associate.
- password String
(Required unless
manage_master_user_password
is set to true or unless asnapshot_identifier
orreplicate_source_db
is provided ormanage_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 ifmanage_master_user_password
is set totrue
.- performance
Insights BooleanEnabled Specifies whether Performance Insights are enabled. Defaults to false.
- performance
Insights StringKms Key Id 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 IntegerRetention Period Amount of time in days to retain Performance Insights data. Valid values are
7
,731
(2 years) or a multiple of31
. When specifyingperformance_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.
- publicly
Accessible Boolean Bool to control if instance is publicly accessible. Default is
false
.- replica
Mode String Specifies whether the replica is in either
mounted
oropen-read-only
mode. This attribute is only supported by Oracle instances. Oracle replicas operate inopen-read-only
mode unless otherwise specified. See Working with Oracle Read Replicas for more information.- replicate
Source StringDb 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 akms_key_id
. See [DB Instance Replication][instance-replication] and Working with PostgreSQL and MySQL Read Replicas for more information on using Replication.- restore
To InstancePoint In Time Restore To Point In Time 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
Instance
S3Import Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance
- skip
Final BooleanSnapshot 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 isfalse
.- snapshot
Identifier 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.
- storage
Encrypted 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 isfalse
if not specified.- storage
Throughput Integer The storage throughput value for the DB instance. Can only be set when
storage_type
is"gp3"
. Cannot be specified if theallocated_storage
value is below a per-engine
threshold. See the RDS User Guide for details.- storage
Type 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" ifiops
is specified, "gp2" if not.- 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. Thetimezone
can only be set on creation. See MSSQL User Guide for more information.- username String
(Required unless a
snapshot_identifier
orreplicate_source_db
is provided) Username for the master DB user. Cannot be specified for a replica.- vpc
Security List<String>Group Ids List of VPC security groups to associate.
- instance
Class string | InstanceType The instance type of the RDS instance.
- allocated
Storage 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. Ifreplicate_source_db
is set, the value is ignored during the creation of the instance.- allow
Major booleanVersion Upgrade 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 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.- auto
Minor booleanVersion Upgrade Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaults to true.
- availability
Zone string The AZ for the RDS instance.
- backup
Retention numberPeriod The days to retain backups for. Must be between
0
and35
. Default is0
. Must be greater than0
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
Target string Specifies where automated backups and manual snapshots are stored. Possible values are
region
(default) andoutposts
. See Working with Amazon RDS on AWS Outposts for more information.- backup
Window 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
.- blue
Green InstanceUpdate Blue Green Update Enables low-downtime updates using [RDS Blue/Green deployments][blue-green]. See blue_green_update below
- ca
Cert stringIdentifier The identifier of the CA certificate for the DB instance.
- character
Set stringName 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.
- boolean
Copy all Instance
tags
to snapshots. Default isfalse
.- custom
Iam stringInstance Profile The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
- customer
Owned booleanIp Enabled 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 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.
- db
Subnet stringGroup Name 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 booleanBackups Specifies whether to remove automated backups immediately after the DB instance is deleted. Default is
true
.- deletion
Protection 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 isfalse
.- domain string
The ID of the Directory Service Active Directory domain to create the instance in.
- domain
Iam stringRole Name The name of the IAM role to be used when making API calls to the Directory Service.
- enabled
Cloudwatch string[]Logs Exports 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.
- engine
Version string The engine version to use. If
auto_minor_version_upgrade
is enabled, you can provide a prefix of the version such as5.7
(for5.7.10
). The actual engine version used is returned in the attributeengine_version_actual
, see Attribute 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 stringIdentifier The name of your final DB snapshot when this DB instance is deleted. Must be provided if
skip_final_snapshot
is set tofalse
. 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 booleanAuthentication Enabled 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.- identifier
Prefix 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 theallocated_storage
value is below a per-engine
threshold. See the RDS User Guide for details.- kms
Key stringId The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.
- license
Model string (Optional, but required for some DB engines, i.e., Oracle SE1) License model information for this DB instance.
- maintenance
Window 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.
- manage
Master booleanUser Password Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if
password
is provided.- master
User stringSecret Kms Key Id 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 numberStorage 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 toallocated_storage
or0
to disable Storage Autoscaling.- monitoring
Interval 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.
- monitoring
Role stringArn 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 boolean Specifies if the RDS instance is multi-AZ
- name string
This property has been deprecated. Please use 'dbName' instead.
- nchar
Character stringSet Name 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 string The network type of the DB instance. Valid values:
IPV4
,DUAL
.- option
Group stringName Name of the DB option group to associate.
- parameter
Group stringName Name of the DB parameter group to associate.
- password string
(Required unless
manage_master_user_password
is set to true or unless asnapshot_identifier
orreplicate_source_db
is provided ormanage_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 ifmanage_master_user_password
is set totrue
.- performance
Insights booleanEnabled Specifies whether Performance Insights are enabled. Defaults to false.
- performance
Insights stringKms Key Id 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 numberRetention Period Amount of time in days to retain Performance Insights data. Valid values are
7
,731
(2 years) or a multiple of31
. When specifyingperformance_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.
- publicly
Accessible boolean Bool to control if instance is publicly accessible. Default is
false
.- replica
Mode string Specifies whether the replica is in either
mounted
oropen-read-only
mode. This attribute is only supported by Oracle instances. Oracle replicas operate inopen-read-only
mode unless otherwise specified. See Working with Oracle Read Replicas for more information.- replicate
Source stringDb 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 akms_key_id
. See [DB Instance Replication][instance-replication] and Working with PostgreSQL and MySQL Read Replicas for more information on using Replication.- restore
To InstancePoint In Time Restore To Point In Time 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
Instance
S3Import Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance
- skip
Final booleanSnapshot 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 isfalse
.- snapshot
Identifier 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.
- storage
Encrypted 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 isfalse
if not specified.- storage
Throughput number The storage throughput value for the DB instance. Can only be set when
storage_type
is"gp3"
. Cannot be specified if theallocated_storage
value is below a per-engine
threshold. See the RDS User Guide for details.- storage
Type 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" ifiops
is specified, "gp2" if not.- {[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. Thetimezone
can only be set on creation. See MSSQL User Guide for more information.- username string
(Required unless a
snapshot_identifier
orreplicate_source_db
is provided) Username for the master DB user. Cannot be specified for a replica.- vpc
Security string[]Group Ids 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. Ifreplicate_source_db
is set, the value is ignored during the creation of the instance.- allow_
major_ boolversion_ upgrade 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_ boolversion_ upgrade 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_ intperiod The days to retain backups for. Must be between
0
and35
. Default is0
. Must be greater than0
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_
target str Specifies where automated backups and manual snapshots are stored. Possible values are
region
(default) andoutposts
. See Working with Amazon RDS on AWS Outposts for more information.- 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_ Instanceupdate Blue Green Update Args Enables low-downtime updates using [RDS Blue/Green deployments][blue-green]. See blue_green_update below
- ca_
cert_ stridentifier The identifier of the CA certificate for the DB instance.
- character_
set_ strname 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.
- bool
Copy all Instance
tags
to snapshots. Default isfalse
.- custom_
iam_ strinstance_ profile The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
- customer_
owned_ boolip_ enabled 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_ strgroup_ name 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_ boolbackups 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 isfalse
.- domain str
The ID of the Directory Service Active Directory domain to create the instance in.
- domain_
iam_ strrole_ name The name of the IAM role to be used when making API calls to the Directory Service.
- enabled_
cloudwatch_ Sequence[str]logs_ exports 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 as5.7
(for5.7.10
). The actual engine version used is returned in the attributeengine_version_actual
, see Attribute 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_ stridentifier The name of your final DB snapshot when this DB instance is deleted. Must be provided if
skip_final_snapshot
is set tofalse
. 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_ boolauthentication_ enabled 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 theallocated_storage
value is below a per-engine
threshold. See the RDS User Guide for details.- kms_
key_ strid 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_ booluser_ password Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if
password
is provided.- master_
user_ strsecret_ kms_ key_ id 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_ intstorage 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 toallocated_storage
or0
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_ strarn 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
This property has been deprecated. Please use 'dbName' instead.
- nchar_
character_ strset_ name 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_ strname Name of the DB option group to associate.
- parameter_
group_ strname Name of the DB parameter group to associate.
- password str
(Required unless
manage_master_user_password
is set to true or unless asnapshot_identifier
orreplicate_source_db
is provided ormanage_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 ifmanage_master_user_password
is set totrue
.- performance_
insights_ boolenabled Specifies whether Performance Insights are enabled. Defaults to false.
- performance_
insights_ strkms_ key_ id 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_ intretention_ period Amount of time in days to retain Performance Insights data. Valid values are
7
,731
(2 years) or a multiple of31
. When specifyingperformance_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
oropen-read-only
mode. This attribute is only supported by Oracle instances. Oracle replicas operate inopen-read-only
mode unless otherwise specified. See Working with Oracle Read Replicas for more information.- replicate_
source_ strdb 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 akms_key_id
. See [DB Instance Replication][instance-replication] and Working with PostgreSQL and MySQL Read Replicas for more information on using Replication.- restore_
to_ Instancepoint_ in_ time Restore To Point In Time Args 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 InstanceS3Import Args Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance
- skip_
final_ boolsnapshot 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 isfalse
.- 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 isfalse
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 theallocated_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" ifiops
is specified, "gp2" if not.- 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. Thetimezone
can only be set on creation. See MSSQL User Guide for more information.- username str
(Required unless a
snapshot_identifier
orreplicate_source_db
is provided) Username for the master DB user. Cannot be specified for a replica.- vpc_
security_ Sequence[str]group_ ids List of VPC security groups to associate.
- instance
Class 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.
- allocated
Storage 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. Ifreplicate_source_db
is set, the value is ignored during the creation of the instance.- allow
Major BooleanVersion Upgrade 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 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.- auto
Minor BooleanVersion Upgrade Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaults to true.
- availability
Zone String The AZ for the RDS instance.
- backup
Retention NumberPeriod The days to retain backups for. Must be between
0
and35
. Default is0
. Must be greater than0
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
Target String Specifies where automated backups and manual snapshots are stored. Possible values are
region
(default) andoutposts
. See Working with Amazon RDS on AWS Outposts for more information.- backup
Window 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
.- blue
Green Property MapUpdate Enables low-downtime updates using [RDS Blue/Green deployments][blue-green]. See blue_green_update below
- ca
Cert StringIdentifier The identifier of the CA certificate for the DB instance.
- character
Set StringName 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.
- Boolean
Copy all Instance
tags
to snapshots. Default isfalse
.- custom
Iam StringInstance Profile The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
- customer
Owned BooleanIp Enabled 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 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.
- db
Subnet StringGroup Name 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 BooleanBackups Specifies whether to remove automated backups immediately after the DB instance is deleted. Default is
true
.- deletion
Protection 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 isfalse
.- domain String
The ID of the Directory Service Active Directory domain to create the instance in.
- domain
Iam StringRole Name The name of the IAM role to be used when making API calls to the Directory Service.
- enabled
Cloudwatch List<String>Logs Exports 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.
- engine
Version String The engine version to use. If
auto_minor_version_upgrade
is enabled, you can provide a prefix of the version such as5.7
(for5.7.10
). The actual engine version used is returned in the attributeengine_version_actual
, see Attribute 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 StringIdentifier The name of your final DB snapshot when this DB instance is deleted. Must be provided if
skip_final_snapshot
is set tofalse
. 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 BooleanAuthentication Enabled 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.- identifier
Prefix 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 theallocated_storage
value is below a per-engine
threshold. See the RDS User Guide for details.- kms
Key StringId The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.
- license
Model String (Optional, but required for some DB engines, i.e., Oracle SE1) License model information for this DB instance.
- maintenance
Window 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.
- manage
Master BooleanUser Password Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if
password
is provided.- master
User StringSecret Kms Key Id 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 NumberStorage 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 toallocated_storage
or0
to disable Storage Autoscaling.- monitoring
Interval 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.
- monitoring
Role StringArn 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 Boolean Specifies if the RDS instance is multi-AZ
- name String
This property has been deprecated. Please use 'dbName' instead.
- nchar
Character StringSet Name 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 String The network type of the DB instance. Valid values:
IPV4
,DUAL
.- option
Group StringName Name of the DB option group to associate.
- parameter
Group StringName Name of the DB parameter group to associate.
- password String
(Required unless
manage_master_user_password
is set to true or unless asnapshot_identifier
orreplicate_source_db
is provided ormanage_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 ifmanage_master_user_password
is set totrue
.- performance
Insights BooleanEnabled Specifies whether Performance Insights are enabled. Defaults to false.
- performance
Insights StringKms Key Id 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 NumberRetention Period Amount of time in days to retain Performance Insights data. Valid values are
7
,731
(2 years) or a multiple of31
. When specifyingperformance_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.
- publicly
Accessible Boolean Bool to control if instance is publicly accessible. Default is
false
.- replica
Mode String Specifies whether the replica is in either
mounted
oropen-read-only
mode. This attribute is only supported by Oracle instances. Oracle replicas operate inopen-read-only
mode unless otherwise specified. See Working with Oracle Read Replicas for more information.- replicate
Source StringDb 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 akms_key_id
. See [DB Instance Replication][instance-replication] and Working with PostgreSQL and MySQL Read Replicas for more information on using Replication.- restore
To Property MapPoint In Time 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
- skip
Final BooleanSnapshot 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 isfalse
.- snapshot
Identifier 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.
- storage
Encrypted 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 isfalse
if not specified.- storage
Throughput Number The storage throughput value for the DB instance. Can only be set when
storage_type
is"gp3"
. Cannot be specified if theallocated_storage
value is below a per-engine
threshold. See the RDS User Guide for details.- storage
Type 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" ifiops
is specified, "gp2" if not.- 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. Thetimezone
can only be set on creation. See MSSQL User Guide for more information.- username String
(Required unless a
snapshot_identifier
orreplicate_source_db
is provided) Username for the master DB user. Cannot be specified for a replica.- vpc
Security List<String>Group Ids 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.- Engine
Version stringActual The running version of the database.
- Hosted
Zone stringId 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.
- Latest
Restorable stringTime The latest time, in UTC RFC3339 format, to which a database can be restored with point-in-time restore.
- Listener
Endpoints List<InstanceListener Endpoint> Specifies the listener connection endpoint for SQL Server Always On. See endpoint below.
- Master
User List<InstanceSecrets Master User Secret> A block that specifies the master user secret. Only available when
manage_master_user_password
is set to true. Documented below.- Replicas List<string>
- Resource
Id string The RDS Resource ID of this instance.
- Status string
The RDS instance status.
- Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.
- 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.- Engine
Version stringActual The running version of the database.
- Hosted
Zone stringId 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.
- Latest
Restorable stringTime The latest time, in UTC RFC3339 format, to which a database can be restored with point-in-time restore.
- Listener
Endpoints []InstanceListener Endpoint Specifies the listener connection endpoint for SQL Server Always On. See endpoint below.
- Master
User []InstanceSecrets Master User Secret A block that specifies the master user secret. Only available when
manage_master_user_password
is set to true. Documented below.- Replicas []string
- Resource
Id string The RDS Resource ID of this instance.
- Status string
The RDS instance status.
- map[string]string
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.
- 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.- engine
Version StringActual The running version of the database.
- hosted
Zone StringId 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.
- latest
Restorable StringTime The latest time, in UTC RFC3339 format, to which a database can be restored with point-in-time restore.
- listener
Endpoints List<InstanceListener Endpoint> Specifies the listener connection endpoint for SQL Server Always On. See endpoint below.
- master
User List<InstanceSecrets Master User Secret> A block that specifies the master user secret. Only available when
manage_master_user_password
is set to true. Documented below.- replicas List<String>
- resource
Id String The RDS Resource ID of this instance.
- status String
The RDS instance status.
- Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.
- 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.- engine
Version stringActual The running version of the database.
- hosted
Zone stringId 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.
- latest
Restorable stringTime The latest time, in UTC RFC3339 format, to which a database can be restored with point-in-time restore.
- listener
Endpoints InstanceListener Endpoint[] Specifies the listener connection endpoint for SQL Server Always On. See endpoint below.
- master
User InstanceSecrets Master User Secret[] A block that specifies the master user secret. Only available when
manage_master_user_password
is set to true. Documented below.- replicas string[]
- resource
Id string The RDS Resource ID of this instance.
- status string
The RDS instance status.
- {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.
- 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_ stractual The running version of the database.
- hosted_
zone_ strid 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_ strtime The latest time, in UTC RFC3339 format, to which a database can be restored with point-in-time restore.
- listener_
endpoints Sequence[InstanceListener Endpoint] Specifies the listener connection endpoint for SQL Server Always On. See endpoint below.
- master_
user_ Sequence[Instancesecrets Master User Secret] 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.
- Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.
- 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.- engine
Version StringActual The running version of the database.
- hosted
Zone StringId 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.
- latest
Restorable StringTime The latest time, in UTC RFC3339 format, to which a database can be restored with point-in-time restore.
- listener
Endpoints List<Property Map> Specifies the listener connection endpoint for SQL Server Always On. See endpoint below.
- master
User List<Property Map>Secrets A block that specifies the master user secret. Only available when
manage_master_user_password
is set to true. Documented below.- replicas List<String>
- resource
Id String The RDS Resource ID of this instance.
- status String
The RDS instance status.
- Map<String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.
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_target: Optional[str] = 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,
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)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Address string
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. Ifreplicate_source_db
is set, the value is ignored during the creation of the instance.- Allow
Major boolVersion Upgrade 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 string
The ARN of the RDS instance.
- Auto
Minor boolVersion Upgrade Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaults to true.
- Availability
Zone string The AZ for the RDS instance.
- Backup
Retention intPeriod The days to retain backups for. Must be between
0
and35
. Default is0
. Must be greater than0
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
Target string Specifies where automated backups and manual snapshots are stored. Possible values are
region
(default) andoutposts
. See Working with Amazon RDS on AWS Outposts for more information.- Backup
Window 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
.- Blue
Green InstanceUpdate Blue Green Update Enables low-downtime updates using [RDS Blue/Green deployments][blue-green]. See blue_green_update below
- Ca
Cert stringIdentifier The identifier of the CA certificate for the DB instance.
- Character
Set stringName 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.
- bool
Copy all Instance
tags
to snapshots. Default isfalse
.- Custom
Iam stringInstance Profile The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
- Customer
Owned boolIp Enabled 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 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.
- Db
Subnet stringGroup Name 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 boolBackups 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 isfalse
.- Domain string
The ID of the Directory Service Active Directory domain to create the instance in.
- Domain
Iam stringRole Name The name of the IAM role to be used when making API calls to the Directory Service.
- Enabled
Cloudwatch List<string>Logs Exports 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.
- Engine
Version string The engine version to use. If
auto_minor_version_upgrade
is enabled, you can provide a prefix of the version such as5.7
(for5.7.10
). The actual engine version used is returned in the attributeengine_version_actual
, see Attribute 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 stringActual The running version of the database.
- Final
Snapshot stringIdentifier The name of your final DB snapshot when this DB instance is deleted. Must be provided if
skip_final_snapshot
is set tofalse
. 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 stringId Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
- Iam
Database boolAuthentication Enabled 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.- Identifier
Prefix string Creates a unique identifier beginning with the specified prefix. Conflicts with
identifier
.- Instance
Class string | Pulumi.Aws. Rds. Instance Type 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 theallocated_storage
value is below a per-engine
threshold. See the RDS User Guide for details.- Kms
Key stringId The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.
- Latest
Restorable stringTime The latest time, in UTC RFC3339 format, to which a database can be restored with point-in-time restore.
- License
Model string (Optional, but required for some DB engines, i.e., Oracle SE1) License model information for this DB instance.
- Listener
Endpoints List<InstanceListener Endpoint> Specifies the listener connection endpoint for SQL Server Always On. See endpoint below.
- Maintenance
Window 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.
- Manage
Master boolUser Password Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if
password
is provided.- Master
User stringSecret Kms Key Id 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 List<InstanceSecrets Master User Secret> A block that specifies the master user secret. Only available when
manage_master_user_password
is set to true. Documented below.- Max
Allocated intStorage 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 toallocated_storage
or0
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 stringArn 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 string
This property has been deprecated. Please use 'dbName' instead.
- Nchar
Character stringSet Name 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 string The network type of the DB instance. Valid values:
IPV4
,DUAL
.- Option
Group stringName Name of the DB option group to associate.
- Parameter
Group stringName Name of the DB parameter group to associate.
- Password string
(Required unless
manage_master_user_password
is set to true or unless asnapshot_identifier
orreplicate_source_db
is provided ormanage_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 ifmanage_master_user_password
is set totrue
.- Performance
Insights boolEnabled Specifies whether Performance Insights are enabled. Defaults to false.
- Performance
Insights stringKms Key Id 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 intRetention Period Amount of time in days to retain Performance Insights data. Valid values are
7
,731
(2 years) or a multiple of31
. When specifyingperformance_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 string Specifies whether the replica is in either
mounted
oropen-read-only
mode. This attribute is only supported by Oracle instances. Oracle replicas operate inopen-read-only
mode unless otherwise specified. See Working with Oracle Read Replicas for more information.- Replicas List<string>
- Replicate
Source stringDb 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 akms_key_id
. See [DB Instance Replication][instance-replication] and Working with PostgreSQL and MySQL Read Replicas for more information on using Replication.- Resource
Id string The RDS Resource ID of this instance.
- Restore
To InstancePoint In Time Restore To Point In Time 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
Instance
S3Import Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance
- Skip
Final boolSnapshot 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 isfalse
.- Snapshot
Identifier 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.
- 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 isfalse
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 theallocated_storage
value is below a per-engine
threshold. See the RDS User Guide for details.- Storage
Type string | Pulumi.Aws. Rds. Storage Type 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" ifiops
is specified, "gp2" if not.- 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.- Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- Timezone string
Time zone of the DB instance.
timezone
is currently only supported by Microsoft SQL Server. Thetimezone
can only be set on creation. See MSSQL User Guide for more information.- Username string
(Required unless a
snapshot_identifier
orreplicate_source_db
is provided) Username for the master DB user. Cannot be specified for a replica.- Vpc
Security List<string>Group Ids List of VPC security groups to associate.
- Address string
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. Ifreplicate_source_db
is set, the value is ignored during the creation of the instance.- Allow
Major boolVersion Upgrade 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 string
The ARN of the RDS instance.
- Auto
Minor boolVersion Upgrade Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaults to true.
- Availability
Zone string The AZ for the RDS instance.
- Backup
Retention intPeriod The days to retain backups for. Must be between
0
and35
. Default is0
. Must be greater than0
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
Target string Specifies where automated backups and manual snapshots are stored. Possible values are
region
(default) andoutposts
. See Working with Amazon RDS on AWS Outposts for more information.- Backup
Window 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
.- Blue
Green InstanceUpdate Blue Green Update Args Enables low-downtime updates using [RDS Blue/Green deployments][blue-green]. See blue_green_update below
- Ca
Cert stringIdentifier The identifier of the CA certificate for the DB instance.
- Character
Set stringName 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.
- bool
Copy all Instance
tags
to snapshots. Default isfalse
.- Custom
Iam stringInstance Profile The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
- Customer
Owned boolIp Enabled 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 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.
- Db
Subnet stringGroup Name 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 boolBackups 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 isfalse
.- Domain string
The ID of the Directory Service Active Directory domain to create the instance in.
- Domain
Iam stringRole Name The name of the IAM role to be used when making API calls to the Directory Service.
- Enabled
Cloudwatch []stringLogs Exports 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.
- Engine
Version string The engine version to use. If
auto_minor_version_upgrade
is enabled, you can provide a prefix of the version such as5.7
(for5.7.10
). The actual engine version used is returned in the attributeengine_version_actual
, see Attribute 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 stringActual The running version of the database.
- Final
Snapshot stringIdentifier The name of your final DB snapshot when this DB instance is deleted. Must be provided if
skip_final_snapshot
is set tofalse
. 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 stringId Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
- Iam
Database boolAuthentication Enabled 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.- Identifier
Prefix string Creates a unique identifier beginning with the specified prefix. Conflicts with
identifier
.- Instance
Class 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 theallocated_storage
value is below a per-engine
threshold. See the RDS User Guide for details.- Kms
Key stringId The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.
- Latest
Restorable stringTime The latest time, in UTC RFC3339 format, to which a database can be restored with point-in-time restore.
- License
Model string (Optional, but required for some DB engines, i.e., Oracle SE1) License model information for this DB instance.
- Listener
Endpoints []InstanceListener Endpoint Args Specifies the listener connection endpoint for SQL Server Always On. See endpoint below.
- Maintenance
Window 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.
- Manage
Master boolUser Password Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if
password
is provided.- Master
User stringSecret Kms Key Id 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 []InstanceSecrets Master User Secret Args A block that specifies the master user secret. Only available when
manage_master_user_password
is set to true. Documented below.- Max
Allocated intStorage 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 toallocated_storage
or0
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 stringArn 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 string
This property has been deprecated. Please use 'dbName' instead.
- Nchar
Character stringSet Name 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 string The network type of the DB instance. Valid values:
IPV4
,DUAL
.- Option
Group stringName Name of the DB option group to associate.
- Parameter
Group stringName Name of the DB parameter group to associate.
- Password string
(Required unless
manage_master_user_password
is set to true or unless asnapshot_identifier
orreplicate_source_db
is provided ormanage_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 ifmanage_master_user_password
is set totrue
.- Performance
Insights boolEnabled Specifies whether Performance Insights are enabled. Defaults to false.
- Performance
Insights stringKms Key Id 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 intRetention Period Amount of time in days to retain Performance Insights data. Valid values are
7
,731
(2 years) or a multiple of31
. When specifyingperformance_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 string Specifies whether the replica is in either
mounted
oropen-read-only
mode. This attribute is only supported by Oracle instances. Oracle replicas operate inopen-read-only
mode unless otherwise specified. See Working with Oracle Read Replicas for more information.- Replicas []string
- Replicate
Source stringDb 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 akms_key_id
. See [DB Instance Replication][instance-replication] and Working with PostgreSQL and MySQL Read Replicas for more information on using Replication.- Resource
Id string The RDS Resource ID of this instance.
- Restore
To InstancePoint In Time Restore To Point In Time Args 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
Instance
S3Import Args Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance
- Skip
Final boolSnapshot 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 isfalse
.- Snapshot
Identifier 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.
- 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 isfalse
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 theallocated_storage
value is below a per-engine
threshold. See the RDS User Guide for details.- Storage
Type 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" ifiops
is specified, "gp2" if not.- 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.- map[string]string
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- Timezone string
Time zone of the DB instance.
timezone
is currently only supported by Microsoft SQL Server. Thetimezone
can only be set on creation. See MSSQL User Guide for more information.- Username string
(Required unless a
snapshot_identifier
orreplicate_source_db
is provided) Username for the master DB user. Cannot be specified for a replica.- Vpc
Security []stringGroup Ids List of VPC security groups to associate.
- address String
Specifies the DNS address of the DB instance.
- allocated
Storage 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. Ifreplicate_source_db
is set, the value is ignored during the creation of the instance.- allow
Major BooleanVersion Upgrade 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 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.
- auto
Minor BooleanVersion Upgrade Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaults to true.
- availability
Zone String The AZ for the RDS instance.
- backup
Retention IntegerPeriod The days to retain backups for. Must be between
0
and35
. Default is0
. Must be greater than0
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
Target String Specifies where automated backups and manual snapshots are stored. Possible values are
region
(default) andoutposts
. See Working with Amazon RDS on AWS Outposts for more information.- backup
Window 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
.- blue
Green InstanceUpdate Blue Green Update Enables low-downtime updates using [RDS Blue/Green deployments][blue-green]. See blue_green_update below
- ca
Cert StringIdentifier The identifier of the CA certificate for the DB instance.
- character
Set StringName 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.
- Boolean
Copy all Instance
tags
to snapshots. Default isfalse
.- custom
Iam StringInstance Profile The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
- customer
Owned BooleanIp Enabled 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 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.
- db
Subnet StringGroup Name 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 BooleanBackups Specifies whether to remove automated backups immediately after the DB instance is deleted. Default is
true
.- deletion
Protection 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 isfalse
.- domain String
The ID of the Directory Service Active Directory domain to create the instance in.
- domain
Iam StringRole Name The name of the IAM role to be used when making API calls to the Directory Service.
- enabled
Cloudwatch List<String>Logs Exports 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.
- engine
Version String The engine version to use. If
auto_minor_version_upgrade
is enabled, you can provide a prefix of the version such as5.7
(for5.7.10
). The actual engine version used is returned in the attributeengine_version_actual
, see Attribute 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 StringActual The running version of the database.
- final
Snapshot StringIdentifier The name of your final DB snapshot when this DB instance is deleted. Must be provided if
skip_final_snapshot
is set tofalse
. 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 StringId Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
- iam
Database BooleanAuthentication Enabled 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.- identifier
Prefix String Creates a unique identifier beginning with the specified prefix. Conflicts with
identifier
.- instance
Class 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 theallocated_storage
value is below a per-engine
threshold. See the RDS User Guide for details.- kms
Key StringId The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.
- latest
Restorable StringTime The latest time, in UTC RFC3339 format, to which a database can be restored with point-in-time restore.
- license
Model String (Optional, but required for some DB engines, i.e., Oracle SE1) License model information for this DB instance.
- listener
Endpoints List<InstanceListener Endpoint> Specifies the listener connection endpoint for SQL Server Always On. See endpoint below.
- maintenance
Window 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.
- manage
Master BooleanUser Password Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if
password
is provided.- master
User StringSecret Kms Key Id 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 List<InstanceSecrets Master User Secret> A block that specifies the master user secret. Only available when
manage_master_user_password
is set to true. Documented below.- max
Allocated IntegerStorage 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 toallocated_storage
or0
to disable Storage Autoscaling.- monitoring
Interval 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.
- monitoring
Role StringArn 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 Boolean Specifies if the RDS instance is multi-AZ
- name String
This property has been deprecated. Please use 'dbName' instead.
- nchar
Character StringSet Name 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 String The network type of the DB instance. Valid values:
IPV4
,DUAL
.- option
Group StringName Name of the DB option group to associate.
- parameter
Group StringName Name of the DB parameter group to associate.
- password String
(Required unless
manage_master_user_password
is set to true or unless asnapshot_identifier
orreplicate_source_db
is provided ormanage_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 ifmanage_master_user_password
is set totrue
.- performance
Insights BooleanEnabled Specifies whether Performance Insights are enabled. Defaults to false.
- performance
Insights StringKms Key Id 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 IntegerRetention Period Amount of time in days to retain Performance Insights data. Valid values are
7
,731
(2 years) or a multiple of31
. When specifyingperformance_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.
- publicly
Accessible Boolean Bool to control if instance is publicly accessible. Default is
false
.- replica
Mode String Specifies whether the replica is in either
mounted
oropen-read-only
mode. This attribute is only supported by Oracle instances. Oracle replicas operate inopen-read-only
mode unless otherwise specified. See Working with Oracle Read Replicas for more information.- replicas List<String>
- replicate
Source StringDb 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 akms_key_id
. See [DB Instance Replication][instance-replication] and Working with PostgreSQL and MySQL Read Replicas for more information on using Replication.- resource
Id String The RDS Resource ID of this instance.
- restore
To InstancePoint In Time Restore To Point In Time 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
Instance
S3Import Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance
- skip
Final BooleanSnapshot 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 isfalse
.- snapshot
Identifier 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.
- storage
Encrypted 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 isfalse
if not specified.- storage
Throughput Integer The storage throughput value for the DB instance. Can only be set when
storage_type
is"gp3"
. Cannot be specified if theallocated_storage
value is below a per-engine
threshold. See the RDS User Guide for details.- storage
Type 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" ifiops
is specified, "gp2" if not.- 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.- Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- timezone String
Time zone of the DB instance.
timezone
is currently only supported by Microsoft SQL Server. Thetimezone
can only be set on creation. See MSSQL User Guide for more information.- username String
(Required unless a
snapshot_identifier
orreplicate_source_db
is provided) Username for the master DB user. Cannot be specified for a replica.- vpc
Security List<String>Group Ids List of VPC security groups to associate.
- address string
Specifies the DNS address of the DB instance.
- allocated
Storage 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. Ifreplicate_source_db
is set, the value is ignored during the creation of the instance.- allow
Major booleanVersion Upgrade 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 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.
- auto
Minor booleanVersion Upgrade Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaults to true.
- availability
Zone string The AZ for the RDS instance.
- backup
Retention numberPeriod The days to retain backups for. Must be between
0
and35
. Default is0
. Must be greater than0
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
Target string Specifies where automated backups and manual snapshots are stored. Possible values are
region
(default) andoutposts
. See Working with Amazon RDS on AWS Outposts for more information.- backup
Window 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
.- blue
Green InstanceUpdate Blue Green Update Enables low-downtime updates using [RDS Blue/Green deployments][blue-green]. See blue_green_update below
- ca
Cert stringIdentifier The identifier of the CA certificate for the DB instance.
- character
Set stringName 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.
- boolean
Copy all Instance
tags
to snapshots. Default isfalse
.- custom
Iam stringInstance Profile The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
- customer
Owned booleanIp Enabled 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 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.
- db
Subnet stringGroup Name 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 booleanBackups Specifies whether to remove automated backups immediately after the DB instance is deleted. Default is
true
.- deletion
Protection 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 isfalse
.- domain string
The ID of the Directory Service Active Directory domain to create the instance in.
- domain
Iam stringRole Name The name of the IAM role to be used when making API calls to the Directory Service.
- enabled
Cloudwatch string[]Logs Exports 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.
- engine
Version string The engine version to use. If
auto_minor_version_upgrade
is enabled, you can provide a prefix of the version such as5.7
(for5.7.10
). The actual engine version used is returned in the attributeengine_version_actual
, see Attribute 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 stringActual The running version of the database.
- final
Snapshot stringIdentifier The name of your final DB snapshot when this DB instance is deleted. Must be provided if
skip_final_snapshot
is set tofalse
. 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 stringId Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
- iam
Database booleanAuthentication Enabled 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.- identifier
Prefix string Creates a unique identifier beginning with the specified prefix. Conflicts with
identifier
.- instance
Class 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 theallocated_storage
value is below a per-engine
threshold. See the RDS User Guide for details.- kms
Key stringId The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.
- latest
Restorable stringTime The latest time, in UTC RFC3339 format, to which a database can be restored with point-in-time restore.
- license
Model string (Optional, but required for some DB engines, i.e., Oracle SE1) License model information for this DB instance.
- listener
Endpoints InstanceListener Endpoint[] Specifies the listener connection endpoint for SQL Server Always On. See endpoint below.
- maintenance
Window 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.
- manage
Master booleanUser Password Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if
password
is provided.- master
User stringSecret Kms Key Id 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 InstanceSecrets Master User Secret[] A block that specifies the master user secret. Only available when
manage_master_user_password
is set to true. Documented below.- max
Allocated numberStorage 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 toallocated_storage
or0
to disable Storage Autoscaling.- monitoring
Interval 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.
- monitoring
Role stringArn 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 boolean Specifies if the RDS instance is multi-AZ
- name string
This property has been deprecated. Please use 'dbName' instead.
- nchar
Character stringSet Name 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 string The network type of the DB instance. Valid values:
IPV4
,DUAL
.- option
Group stringName Name of the DB option group to associate.
- parameter
Group stringName Name of the DB parameter group to associate.
- password string
(Required unless
manage_master_user_password
is set to true or unless asnapshot_identifier
orreplicate_source_db
is provided ormanage_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 ifmanage_master_user_password
is set totrue
.- performance
Insights booleanEnabled Specifies whether Performance Insights are enabled. Defaults to false.
- performance
Insights stringKms Key Id 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 numberRetention Period Amount of time in days to retain Performance Insights data. Valid values are
7
,731
(2 years) or a multiple of31
. When specifyingperformance_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.
- publicly
Accessible boolean Bool to control if instance is publicly accessible. Default is
false
.- replica
Mode string Specifies whether the replica is in either
mounted
oropen-read-only
mode. This attribute is only supported by Oracle instances. Oracle replicas operate inopen-read-only
mode unless otherwise specified. See Working with Oracle Read Replicas for more information.- replicas string[]
- replicate
Source stringDb 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 akms_key_id
. See [DB Instance Replication][instance-replication] and Working with PostgreSQL and MySQL Read Replicas for more information on using Replication.- resource
Id string The RDS Resource ID of this instance.
- restore
To InstancePoint In Time Restore To Point In Time 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
Instance
S3Import Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance
- skip
Final booleanSnapshot 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 isfalse
.- snapshot
Identifier 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.
- storage
Encrypted 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 isfalse
if not specified.- storage
Throughput number The storage throughput value for the DB instance. Can only be set when
storage_type
is"gp3"
. Cannot be specified if theallocated_storage
value is below a per-engine
threshold. See the RDS User Guide for details.- storage
Type 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" ifiops
is specified, "gp2" if not.- {[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.- {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- timezone string
Time zone of the DB instance.
timezone
is currently only supported by Microsoft SQL Server. Thetimezone
can only be set on creation. See MSSQL User Guide for more information.- username string
(Required unless a
snapshot_identifier
orreplicate_source_db
is provided) Username for the master DB user. Cannot be specified for a replica.- vpc
Security string[]Group Ids 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. Ifreplicate_source_db
is set, the value is ignored during the creation of the instance.- allow_
major_ boolversion_ upgrade 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_ boolversion_ upgrade 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_ intperiod The days to retain backups for. Must be between
0
and35
. Default is0
. Must be greater than0
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_
target str Specifies where automated backups and manual snapshots are stored. Possible values are
region
(default) andoutposts
. See Working with Amazon RDS on AWS Outposts for more information.- 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_ Instanceupdate Blue Green Update Args Enables low-downtime updates using [RDS Blue/Green deployments][blue-green]. See blue_green_update below
- ca_
cert_ stridentifier The identifier of the CA certificate for the DB instance.
- character_
set_ strname 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.
- bool
Copy all Instance
tags
to snapshots. Default isfalse
.- custom_
iam_ strinstance_ profile The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
- customer_
owned_ boolip_ enabled 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_ strgroup_ name 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_ boolbackups 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 isfalse
.- domain str
The ID of the Directory Service Active Directory domain to create the instance in.
- domain_
iam_ strrole_ name The name of the IAM role to be used when making API calls to the Directory Service.
- enabled_
cloudwatch_ Sequence[str]logs_ exports 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 as5.7
(for5.7.10
). The actual engine version used is returned in the attributeengine_version_actual
, see Attribute 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_ stractual The running version of the database.
- final_
snapshot_ stridentifier The name of your final DB snapshot when this DB instance is deleted. Must be provided if
skip_final_snapshot
is set tofalse
. 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_ strid Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
- iam_
database_ boolauthentication_ enabled 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 theallocated_storage
value is below a per-engine
threshold. See the RDS User Guide for details.- kms_
key_ strid The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.
- latest_
restorable_ strtime 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[InstanceListener Endpoint Args] 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_ booluser_ password Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if
password
is provided.- master_
user_ strsecret_ kms_ key_ id 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_ Sequence[Instancesecrets Master User Secret Args] A block that specifies the master user secret. Only available when
manage_master_user_password
is set to true. Documented below.- max_
allocated_ intstorage 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 toallocated_storage
or0
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_ strarn 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
This property has been deprecated. Please use 'dbName' instead.
- nchar_
character_ strset_ name 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_ strname Name of the DB option group to associate.
- parameter_
group_ strname Name of the DB parameter group to associate.
- password str
(Required unless
manage_master_user_password
is set to true or unless asnapshot_identifier
orreplicate_source_db
is provided ormanage_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 ifmanage_master_user_password
is set totrue
.- performance_
insights_ boolenabled Specifies whether Performance Insights are enabled. Defaults to false.
- performance_
insights_ strkms_ key_ id 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_ intretention_ period Amount of time in days to retain Performance Insights data. Valid values are
7
,731
(2 years) or a multiple of31
. When specifyingperformance_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
oropen-read-only
mode. This attribute is only supported by Oracle instances. Oracle replicas operate inopen-read-only
mode unless otherwise specified. See Working with Oracle Read Replicas for more information.- replicas Sequence[str]
- replicate_
source_ strdb 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 akms_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_ Instancepoint_ in_ time Restore To Point In Time Args 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 InstanceS3Import Args Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance
- skip_
final_ boolsnapshot 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 isfalse
.- 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 isfalse
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 theallocated_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" ifiops
is specified, "gp2" if not.- 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.- Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- timezone str
Time zone of the DB instance.
timezone
is currently only supported by Microsoft SQL Server. Thetimezone
can only be set on creation. See MSSQL User Guide for more information.- username str
(Required unless a
snapshot_identifier
orreplicate_source_db
is provided) Username for the master DB user. Cannot be specified for a replica.- vpc_
security_ Sequence[str]group_ ids List of VPC security groups to associate.
- address String
Specifies the DNS address of the DB instance.
- allocated
Storage 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. Ifreplicate_source_db
is set, the value is ignored during the creation of the instance.- allow
Major BooleanVersion Upgrade 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 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.
- auto
Minor BooleanVersion Upgrade Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaults to true.
- availability
Zone String The AZ for the RDS instance.
- backup
Retention NumberPeriod The days to retain backups for. Must be between
0
and35
. Default is0
. Must be greater than0
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
Target String Specifies where automated backups and manual snapshots are stored. Possible values are
region
(default) andoutposts
. See Working with Amazon RDS on AWS Outposts for more information.- backup
Window 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
.- blue
Green Property MapUpdate Enables low-downtime updates using [RDS Blue/Green deployments][blue-green]. See blue_green_update below
- ca
Cert StringIdentifier The identifier of the CA certificate for the DB instance.
- character
Set StringName 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.
- Boolean
Copy all Instance
tags
to snapshots. Default isfalse
.- custom
Iam StringInstance Profile The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
- customer
Owned BooleanIp Enabled 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 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.
- db
Subnet StringGroup Name 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 BooleanBackups Specifies whether to remove automated backups immediately after the DB instance is deleted. Default is
true
.- deletion
Protection 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 isfalse
.- domain String
The ID of the Directory Service Active Directory domain to create the instance in.
- domain
Iam StringRole Name The name of the IAM role to be used when making API calls to the Directory Service.
- enabled
Cloudwatch List<String>Logs Exports 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.
- engine
Version String The engine version to use. If
auto_minor_version_upgrade
is enabled, you can provide a prefix of the version such as5.7
(for5.7.10
). The actual engine version used is returned in the attributeengine_version_actual
, see Attribute 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 StringActual The running version of the database.
- final
Snapshot StringIdentifier The name of your final DB snapshot when this DB instance is deleted. Must be provided if
skip_final_snapshot
is set tofalse
. 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 StringId Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
- iam
Database BooleanAuthentication Enabled 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.- identifier
Prefix String Creates a unique identifier beginning with the specified prefix. Conflicts with
identifier
.- instance
Class 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 theallocated_storage
value is below a per-engine
threshold. See the RDS User Guide for details.- kms
Key StringId The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.
- latest
Restorable StringTime The latest time, in UTC RFC3339 format, to which a database can be restored with point-in-time restore.
- license
Model String (Optional, but required for some DB engines, i.e., Oracle SE1) License model information for this DB instance.
- listener
Endpoints List<Property Map> Specifies the listener connection endpoint for SQL Server Always On. See endpoint below.
- maintenance
Window 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.
- manage
Master BooleanUser Password Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if
password
is provided.- master
User StringSecret Kms Key Id 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 List<Property Map>Secrets A block that specifies the master user secret. Only available when
manage_master_user_password
is set to true. Documented below.- max
Allocated NumberStorage 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 toallocated_storage
or0
to disable Storage Autoscaling.- monitoring
Interval 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.
- monitoring
Role StringArn 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 Boolean Specifies if the RDS instance is multi-AZ
- name String
This property has been deprecated. Please use 'dbName' instead.
- nchar
Character StringSet Name 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 String The network type of the DB instance. Valid values:
IPV4
,DUAL
.- option
Group StringName Name of the DB option group to associate.
- parameter
Group StringName Name of the DB parameter group to associate.
- password String
(Required unless
manage_master_user_password
is set to true or unless asnapshot_identifier
orreplicate_source_db
is provided ormanage_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 ifmanage_master_user_password
is set totrue
.- performance
Insights BooleanEnabled Specifies whether Performance Insights are enabled. Defaults to false.
- performance
Insights StringKms Key Id 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 NumberRetention Period Amount of time in days to retain Performance Insights data. Valid values are
7
,731
(2 years) or a multiple of31
. When specifyingperformance_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.
- publicly
Accessible Boolean Bool to control if instance is publicly accessible. Default is
false
.- replica
Mode String Specifies whether the replica is in either
mounted
oropen-read-only
mode. This attribute is only supported by Oracle instances. Oracle replicas operate inopen-read-only
mode unless otherwise specified. See Working with Oracle Read Replicas for more information.- replicas List<String>
- replicate
Source StringDb 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 akms_key_id
. See [DB Instance Replication][instance-replication] and Working with PostgreSQL and MySQL Read Replicas for more information on using Replication.- resource
Id String The RDS Resource ID of this instance.
- restore
To Property MapPoint In Time 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
- skip
Final BooleanSnapshot 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 isfalse
.- snapshot
Identifier 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.
- storage
Encrypted 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 isfalse
if not specified.- storage
Throughput Number The storage throughput value for the DB instance. Can only be set when
storage_type
is"gp3"
. Cannot be specified if theallocated_storage
value is below a per-engine
threshold. See the RDS User Guide for details.- storage
Type 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" ifiops
is specified, "gp2" if not.- 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.- Map<String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- timezone String
Time zone of the DB instance.
timezone
is currently only supported by Microsoft SQL Server. Thetimezone
can only be set on creation. See MSSQL User Guide for more information.- username String
(Required unless a
snapshot_identifier
orreplicate_source_db
is provided) Username for the master DB user. Cannot be specified for a replica.- vpc
Security List<String>Group Ids List of VPC security groups to associate.
Supporting Types
InstanceBlueGreenUpdate, InstanceBlueGreenUpdateArgs
- Enabled bool
Enables low-downtime updates when
true
. Default isfalse
.
- Enabled bool
Enables low-downtime updates when
true
. Default isfalse
.
- enabled Boolean
Enables low-downtime updates when
true
. Default isfalse
.
- enabled boolean
Enables low-downtime updates when
true
. Default isfalse
.
- enabled bool
Enables low-downtime updates when
true
. Default isfalse
.
- enabled Boolean
Enables low-downtime updates when
true
. Default isfalse
.
InstanceListenerEndpoint, InstanceListenerEndpointArgs
- Address string
Specifies the DNS address of the DB instance.
- Hosted
Zone stringId 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.
- Hosted
Zone stringId 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.
- hosted
Zone StringId 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.
- hosted
Zone stringId 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_ strid 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.
- hosted
Zone StringId 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
- Kms
Key stringId The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.
- Secret
Arn string The Amazon Resource Name (ARN) of the secret.
- Secret
Status string The status of the secret. Valid Values:
creating
|active
|rotating
|impaired
.
- Kms
Key stringId The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.
- Secret
Arn string The Amazon Resource Name (ARN) of the secret.
- Secret
Status string The status of the secret. Valid Values:
creating
|active
|rotating
|impaired
.
- kms
Key StringId The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.
- secret
Arn String The Amazon Resource Name (ARN) of the secret.
- secret
Status String The status of the secret. Valid Values:
creating
|active
|rotating
|impaired
.
- kms
Key stringId The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.
- secret
Arn string The Amazon Resource Name (ARN) of the secret.
- secret
Status string The status of the secret. Valid Values:
creating
|active
|rotating
|impaired
.
- kms_
key_ strid 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
.
- kms
Key StringId The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.
- secret
Arn String The Amazon Resource Name (ARN) of the secret.
- secret
Status String The status of the secret. Valid Values:
creating
|active
|rotating
|impaired
.
InstanceRestoreToPointInTime, InstanceRestoreToPointInTimeArgs
- Restore
Time 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
.- Source
Db stringInstance Automated Backups Arn The ARN of the automated backup from which to restore. Required if
source_db_instance_identifier
orsource_dbi_resource_id
is not specified.- Source
Db stringInstance Identifier 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
orsource_dbi_resource_id
is not specified.- Source
Dbi stringResource Id The resource ID of the source DB instance from which to restore. Required if
source_db_instance_identifier
orsource_db_instance_automated_backups_arn
is not specified.- Use
Latest boolRestorable Time A boolean value that indicates whether the DB instance is restored from the latest backup time. Defaults to
false
. Cannot be specified withrestore_time
.
- Restore
Time 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
.- Source
Db stringInstance Automated Backups Arn The ARN of the automated backup from which to restore. Required if
source_db_instance_identifier
orsource_dbi_resource_id
is not specified.- Source
Db stringInstance Identifier 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
orsource_dbi_resource_id
is not specified.- Source
Dbi stringResource Id The resource ID of the source DB instance from which to restore. Required if
source_db_instance_identifier
orsource_db_instance_automated_backups_arn
is not specified.- Use
Latest boolRestorable Time A boolean value that indicates whether the DB instance is restored from the latest backup time. Defaults to
false
. Cannot be specified withrestore_time
.
- restore
Time 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
.- source
Db StringInstance Automated Backups Arn The ARN of the automated backup from which to restore. Required if
source_db_instance_identifier
orsource_dbi_resource_id
is not specified.- source
Db StringInstance Identifier 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
orsource_dbi_resource_id
is not specified.- source
Dbi StringResource Id The resource ID of the source DB instance from which to restore. Required if
source_db_instance_identifier
orsource_db_instance_automated_backups_arn
is not specified.- use
Latest BooleanRestorable Time A boolean value that indicates whether the DB instance is restored from the latest backup time. Defaults to
false
. Cannot be specified withrestore_time
.
- restore
Time 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
.- source
Db stringInstance Automated Backups Arn The ARN of the automated backup from which to restore. Required if
source_db_instance_identifier
orsource_dbi_resource_id
is not specified.- source
Db stringInstance Identifier 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
orsource_dbi_resource_id
is not specified.- source
Dbi stringResource Id The resource ID of the source DB instance from which to restore. Required if
source_db_instance_identifier
orsource_db_instance_automated_backups_arn
is not specified.- use
Latest booleanRestorable Time A boolean value that indicates whether the DB instance is restored from the latest backup time. Defaults to
false
. Cannot be specified withrestore_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_ strinstance_ automated_ backups_ arn The ARN of the automated backup from which to restore. Required if
source_db_instance_identifier
orsource_dbi_resource_id
is not specified.- source_
db_ strinstance_ identifier 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
orsource_dbi_resource_id
is not specified.- source_
dbi_ strresource_ id The resource ID of the source DB instance from which to restore. Required if
source_db_instance_identifier
orsource_db_instance_automated_backups_arn
is not specified.- use_
latest_ boolrestorable_ time A boolean value that indicates whether the DB instance is restored from the latest backup time. Defaults to
false
. Cannot be specified withrestore_time
.
- restore
Time 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
.- source
Db StringInstance Automated Backups Arn The ARN of the automated backup from which to restore. Required if
source_db_instance_identifier
orsource_dbi_resource_id
is not specified.- source
Db StringInstance Identifier 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
orsource_dbi_resource_id
is not specified.- source
Dbi StringResource Id The resource ID of the source DB instance from which to restore. Required if
source_db_instance_identifier
orsource_db_instance_automated_backups_arn
is not specified.- use
Latest BooleanRestorable Time A boolean value that indicates whether the DB instance is restored from the latest backup time. Defaults to
false
. Cannot be specified withrestore_time
.
InstanceS3Import, InstanceS3ImportArgs
- Bucket
Name string The bucket name where your backup is stored
- Ingestion
Role string Role applied to load the data.
- Source
Engine string Source engine for the backup
- Source
Engine stringVersion 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 string Can be blank, but is the path to your backup
- Bucket
Name string The bucket name where your backup is stored
- Ingestion
Role string Role applied to load the data.
- Source
Engine string Source engine for the backup
- Source
Engine stringVersion 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 string Can be blank, but is the path to your backup
- bucket
Name String The bucket name where your backup is stored
- ingestion
Role String Role applied to load the data.
- source
Engine String Source engine for the backup
- source
Engine StringVersion 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 String Can be blank, but is the path to your backup
- bucket
Name string The bucket name where your backup is stored
- ingestion
Role string Role applied to load the data.
- source
Engine string Source engine for the backup
- source
Engine stringVersion 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 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_ strversion 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
- bucket
Name String The bucket name where your backup is stored
- ingestion
Role String Role applied to load the data.
- source
Engine String Source engine for the backup
- source
Engine StringVersion 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 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
- Instance
Type_T4G_Micro - db.t4g.micro
- Instance
Type_T4G_Small - db.t4g.small
- Instance
Type_T4G_Medium - db.t4g.medium
- Instance
Type_T4G_Large - db.t4g.large
- Instance
Type_T4G_XLarge - db.t4g.xlarge
- Instance
Type_T4G_2XLarge - db.t4g.2xlarge
- Instance
Type_T3_Micro - db.t3.micro
- Instance
Type_T3_Small - db.t3.small
- Instance
Type_T3_Medium - db.t3.medium
- Instance
Type_T3_Large - db.t3.large
- Instance
Type_T3_XLarge - db.t3.xlarge
- Instance
Type_T3_2XLarge - db.t3.2xlarge
- Instance
Type_T2_Micro - db.t2.micro
- Instance
Type_T2_Small - db.t2.small
- Instance
Type_T2_Medium - db.t2.medium
- Instance
Type_T2_Large - db.t2.large
- Instance
Type_T2_XLarge - db.t2.xlarge
- Instance
Type_T2_2XLarge - db.t2.2xlarge
- Instance
Type_M1_Small - db.m1.small
- Instance
Type_M1_Medium - db.m1.medium
- Instance
Type_M1_Large - db.m1.large
- Instance
Type_M1_XLarge - db.m1.xlarge
- Instance
Type_M2_XLarge - db.m2.xlarge
- Instance
Type_M2_2XLarge - db.m2.2xlarge
- Instance
Type_M2_4XLarge - db.m2.4xlarge
- Instance
Type_M3_Medium - db.m3.medium
- Instance
Type_M3_Large - db.m3.large
- Instance
Type_M3_XLarge - db.m3.xlarge
- Instance
Type_M3_2XLarge - db.m3.2xlarge
- Instance
Type_M4_Large - db.m4.large
- Instance
Type_M4_XLarge - db.m4.xlarge
- Instance
Type_M4_2XLarge - db.m4.2xlarge
- Instance
Type_M4_4XLarge - db.m4.4xlarge
- Instance
Type_M4_10XLarge - db.m4.10xlarge
- Instance
Type_M4_16XLarge - db.m4.10xlarge
- Instance
Type_M5_Large - db.m5.large
- Instance
Type_M5_XLarge - db.m5.xlarge
- Instance
Type_M5_2XLarge - db.m5.2xlarge
- Instance
Type_M5_4XLarge - db.m5.4xlarge
- Instance
Type_M5_12XLarge - db.m5.12xlarge
- Instance
Type_M5_24XLarge - db.m5.24xlarge
- Instance
Type_M6G_Large - db.m6g.large
- Instance
Type_M6G_XLarge - db.m6g.xlarge
- Instance
Type_M6G_2XLarge - db.m6g.2xlarge
- Instance
Type_M6G_4XLarge - db.m6g.4xlarge
- Instance
Type_M6G_8XLarge - db.m6g.8xlarge
- Instance
Type_M6G_12XLarge - db.m6g.12xlarge
- Instance
Type_M6G_16XLarge - db.m6g.16xlarge
- Instance
Type_R3_Large - db.r3.large
- Instance
Type_R3_XLarge - db.r3.xlarge
- Instance
Type_R3_2XLarge - db.r3.2xlarge
- Instance
Type_R3_4XLarge - db.r3.4xlarge
- Instance
Type_R3_8XLarge - db.r3.8xlarge
- Instance
Type_R4_Large - db.r4.large
- Instance
Type_R4_XLarge - db.r4.xlarge
- Instance
Type_R4_2XLarge - db.r4.2xlarge
- Instance
Type_R4_4XLarge - db.r4.4xlarge
- Instance
Type_R4_8XLarge - db.r4.8xlarge
- Instance
Type_R4_16XLarge - db.r4.16xlarge
- Instance
Type_R5_Large - db.r5.large
- Instance
Type_R5_XLarge - db.r5.xlarge
- Instance
Type_R5_2XLarge - db.r5.2xlarge
- Instance
Type_R5_4XLarge - db.r5.4xlarge
- Instance
Type_R5_12XLarge - db.r5.12xlarge
- Instance
Type_R5_24XLarge - db.r5.24xlarge
- Instance
Type_R6G_Large - db.r6g.large
- Instance
Type_R6G_XLarge - db.r6g.xlarge
- Instance
Type_R6G_2XLarge - db.r6g.2xlarge
- Instance
Type_R6G_4XLarge - db.r6g.4xlarge
- Instance
Type_R6G_8XLarge - db.r6g.8xlarge
- Instance
Type_R6G_12XLarge - db.r6g.12xlarge
- Instance
Type_R6G_16XLarge - db.r6g.16xlarge
- Instance
Type_X1_16XLarge - db.x1.16xlarge
- Instance
Type_X1_32XLarge - db.x1.32xlarge
- Instance
Type_X1E_XLarge - db.x1e.xlarge
- Instance
Type_X1E_2XLarge - db.x1e.2xlarge
- Instance
Type_X1E_4XLarge - db.x1e.4xlarge
- Instance
Type_X1E_8XLarge - db.x1e.8xlarge
- Instance
Type_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
- Storage
Type Standard - standard
- Storage
Type GP2 - gp2
- Storage
Type GP3 - gp3
- Storage
Type 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
- "standard"
- standard
- "gp2"
- gp2
- "gp3"
- gp3
- "io1"
- io1
Import
Using pulumi import
, import DB Instances using the identifier
. For example:
$ pulumi import aws:rds/instance:Instance default mydb-rds-instance
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.
Try AWS Native preview for resources not in the classic version.