Docs
PackagesTry AWS Native preview for resources not in the classic version.
AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
aws.rds.Instance
Explore with Pulumi AI
Try AWS Native preview for resources not in the classic version.
AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
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_immediatelycan 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 instance classes for the following use cases: General-purpose, Memory-optimized, Burstable Performance, and Optimized-reads. 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, MariaDB and PostgreSQL, as other engines are not supported by RDS Blue/Green deployments. They cannot be used with DB Instances with replicas.
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
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: "8.0",
instanceClass: aws.rds.InstanceType.T3_Micro,
username: "foo",
password: "foobarbaz",
parameterGroupName: "default.mysql8.0",
skipFinalSnapshot: true,
});
import pulumi
import pulumi_aws as aws
default = aws.rds.Instance("default",
allocated_storage=10,
db_name="mydb",
engine="mysql",
engine_version="8.0",
instance_class=aws.rds.InstanceType.T3_MICRO,
username="foo",
password="foobarbaz",
parameter_group_name="default.mysql8.0",
skip_final_snapshot=True)
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/rds"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := rds.NewInstance(ctx, "default", &rds.InstanceArgs{
AllocatedStorage: pulumi.Int(10),
DbName: pulumi.String("mydb"),
Engine: pulumi.String("mysql"),
EngineVersion: pulumi.String("8.0"),
InstanceClass: pulumi.String(rds.InstanceType_T3_Micro),
Username: pulumi.String("foo"),
Password: pulumi.String("foobarbaz"),
ParameterGroupName: pulumi.String("default.mysql8.0"),
SkipFinalSnapshot: pulumi.Bool(true),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var @default = new Aws.Rds.Instance("default", new()
{
AllocatedStorage = 10,
DbName = "mydb",
Engine = "mysql",
EngineVersion = "8.0",
InstanceClass = Aws.Rds.InstanceType.T3_Micro,
Username = "foo",
Password = "foobarbaz",
ParameterGroupName = "default.mysql8.0",
SkipFinalSnapshot = true,
});
});
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("8.0")
.instanceClass("db.t3.micro")
.username("foo")
.password("foobarbaz")
.parameterGroupName("default.mysql8.0")
.skipFinalSnapshot(true)
.build());
}
}
resources:
default:
type: aws:rds:Instance
properties:
allocatedStorage: 10
dbName: mydb
engine: mysql
engineVersion: '8.0'
instanceClass: db.t3.micro
username: foo
password: foobarbaz
parameterGroupName: default.mysql8.0
skipFinalSnapshot: true
RDS Custom for Oracle Usage with Replica
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
// Lookup the available instance classes for the custom engine for the region being operated in
const custom-oracle = aws.rds.getOrderableDbInstance({
engine: "custom-oracle-ee",
engineVersion: "19.c.ee.002",
licenseModel: "bring-your-own-license",
storageType: "gp3",
preferredInstanceClasses: [
"db.r5.xlarge",
"db.r5.2xlarge",
"db.r5.4xlarge",
],
});
// The RDS instance resource requires an ARN. Look up the ARN of the KMS key associated with the CEV.
const byId = aws.kms.getKey({
keyId: "example-ef278353ceba4a5a97de6784565b9f78",
});
const _default = new aws.rds.Instance("default", {
allocatedStorage: 50,
autoMinorVersionUpgrade: false,
customIamInstanceProfile: "AWSRDSCustomInstanceProfile",
backupRetentionPeriod: 7,
dbSubnetGroupName: dbSubnetGroupName,
engine: custom_oracle.then(custom_oracle => custom_oracle.engine),
engineVersion: custom_oracle.then(custom_oracle => custom_oracle.engineVersion),
identifier: "ee-instance-demo",
instanceClass: custom_oracle.then(custom_oracle => custom_oracle.instanceClass).apply((x) => aws.rds.InstanceType[x]),
kmsKeyId: byId.then(byId => byId.arn),
licenseModel: custom_oracle.then(custom_oracle => custom_oracle.licenseModel),
multiAz: false,
password: "avoid-plaintext-passwords",
username: "test",
storageEncrypted: true,
});
const test_replica = new aws.rds.Instance("test-replica", {
replicateSourceDb: _default.identifier,
replicaMode: "mounted",
autoMinorVersionUpgrade: false,
customIamInstanceProfile: "AWSRDSCustomInstanceProfile",
backupRetentionPeriod: 7,
identifier: "ee-instance-replica",
instanceClass: custom_oracle.then(custom_oracle => custom_oracle.instanceClass).apply((x) => aws.rds.InstanceType[x]),
kmsKeyId: byId.then(byId => byId.arn),
multiAz: false,
skipFinalSnapshot: true,
storageEncrypted: true,
});
import pulumi
import pulumi_aws as aws
# Lookup the available instance classes for the custom engine for the region being operated in
custom_oracle = aws.rds.get_orderable_db_instance(engine="custom-oracle-ee",
engine_version="19.c.ee.002",
license_model="bring-your-own-license",
storage_type="gp3",
preferred_instance_classes=[
"db.r5.xlarge",
"db.r5.2xlarge",
"db.r5.4xlarge",
])
# The RDS instance resource requires an ARN. Look up the ARN of the KMS key associated with the CEV.
by_id = aws.kms.get_key(key_id="example-ef278353ceba4a5a97de6784565b9f78")
default = aws.rds.Instance("default",
allocated_storage=50,
auto_minor_version_upgrade=False,
custom_iam_instance_profile="AWSRDSCustomInstanceProfile",
backup_retention_period=7,
db_subnet_group_name=db_subnet_group_name,
engine=custom_oracle.engine,
engine_version=custom_oracle.engine_version,
identifier="ee-instance-demo",
instance_class=custom_oracle.instance_class.apply(lambda x: aws.rds.InstanceType(x)),
kms_key_id=by_id.arn,
license_model=custom_oracle.license_model,
multi_az=False,
password="avoid-plaintext-passwords",
username="test",
storage_encrypted=True)
test_replica = aws.rds.Instance("test-replica",
replicate_source_db=default.identifier,
replica_mode="mounted",
auto_minor_version_upgrade=False,
custom_iam_instance_profile="AWSRDSCustomInstanceProfile",
backup_retention_period=7,
identifier="ee-instance-replica",
instance_class=custom_oracle.instance_class.apply(lambda x: aws.rds.InstanceType(x)),
kms_key_id=by_id.arn,
multi_az=False,
skip_final_snapshot=True,
storage_encrypted=True)
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 {
// Lookup the available instance classes for the custom engine for the region being operated in
custom_oracle, err := rds.GetOrderableDbInstance(ctx, &rds.GetOrderableDbInstanceArgs{
Engine: "custom-oracle-ee",
EngineVersion: pulumi.StringRef("19.c.ee.002"),
LicenseModel: pulumi.StringRef("bring-your-own-license"),
StorageType: pulumi.StringRef("gp3"),
PreferredInstanceClasses: []string{
"db.r5.xlarge",
"db.r5.2xlarge",
"db.r5.4xlarge",
},
}, nil)
if err != nil {
return err
}
// The RDS instance resource requires an ARN. Look up the ARN of the KMS key associated with the CEV.
byId, err := kms.LookupKey(ctx, &kms.LookupKeyArgs{
KeyId: "example-ef278353ceba4a5a97de6784565b9f78",
}, nil)
if err != nil {
return err
}
_, err = rds.NewInstance(ctx, "default", &rds.InstanceArgs{
AllocatedStorage: pulumi.Int(50),
AutoMinorVersionUpgrade: pulumi.Bool(false),
CustomIamInstanceProfile: pulumi.String("AWSRDSCustomInstanceProfile"),
BackupRetentionPeriod: pulumi.Int(7),
DbSubnetGroupName: pulumi.Any(dbSubnetGroupName),
Engine: pulumi.String(custom_oracle.Engine),
EngineVersion: pulumi.String(custom_oracle.EngineVersion),
Identifier: pulumi.String("ee-instance-demo"),
InstanceClass: custom_oracle.InstanceClass.ApplyT(func(x *string) rds.InstanceType { return rds.InstanceType(*x) }).(rds.InstanceTypeOutput),
KmsKeyId: pulumi.String(byId.Arn),
LicenseModel: pulumi.String(custom_oracle.LicenseModel),
MultiAz: pulumi.Bool(false),
Password: pulumi.String("avoid-plaintext-passwords"),
Username: pulumi.String("test"),
StorageEncrypted: pulumi.Bool(true),
})
if err != nil {
return err
}
_, err = rds.NewInstance(ctx, "test-replica", &rds.InstanceArgs{
ReplicateSourceDb: _default.Identifier,
ReplicaMode: pulumi.String("mounted"),
AutoMinorVersionUpgrade: pulumi.Bool(false),
CustomIamInstanceProfile: pulumi.String("AWSRDSCustomInstanceProfile"),
BackupRetentionPeriod: pulumi.Int(7),
Identifier: pulumi.String("ee-instance-replica"),
InstanceClass: custom_oracle.InstanceClass.ApplyT(func(x *string) rds.InstanceType { return rds.InstanceType(*x) }).(rds.InstanceTypeOutput),
KmsKeyId: pulumi.String(byId.Arn),
MultiAz: pulumi.Bool(false),
SkipFinalSnapshot: pulumi.Bool(true),
StorageEncrypted: pulumi.Bool(true),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
// Lookup the available instance classes for the custom engine for the region being operated in
var custom_oracle = Aws.Rds.GetOrderableDbInstance.Invoke(new()
{
Engine = "custom-oracle-ee",
EngineVersion = "19.c.ee.002",
LicenseModel = "bring-your-own-license",
StorageType = "gp3",
PreferredInstanceClasses = new[]
{
"db.r5.xlarge",
"db.r5.2xlarge",
"db.r5.4xlarge",
},
});
// The RDS instance resource requires an ARN. Look up the ARN of the KMS key associated with the CEV.
var byId = Aws.Kms.GetKey.Invoke(new()
{
KeyId = "example-ef278353ceba4a5a97de6784565b9f78",
});
var @default = new Aws.Rds.Instance("default", new()
{
AllocatedStorage = 50,
AutoMinorVersionUpgrade = false,
CustomIamInstanceProfile = "AWSRDSCustomInstanceProfile",
BackupRetentionPeriod = 7,
DbSubnetGroupName = dbSubnetGroupName,
Engine = custom_oracle.Apply(custom_oracle => custom_oracle.Apply(getOrderableDbInstanceResult => getOrderableDbInstanceResult.Engine)),
EngineVersion = custom_oracle.Apply(custom_oracle => custom_oracle.Apply(getOrderableDbInstanceResult => getOrderableDbInstanceResult.EngineVersion)),
Identifier = "ee-instance-demo",
InstanceClass = custom_oracle.Apply(custom_oracle => custom_oracle.Apply(getOrderableDbInstanceResult => getOrderableDbInstanceResult.InstanceClass)).Apply(System.Enum.Parse<Aws.Rds.InstanceType>),
KmsKeyId = byId.Apply(getKeyResult => getKeyResult.Arn),
LicenseModel = custom_oracle.Apply(custom_oracle => custom_oracle.Apply(getOrderableDbInstanceResult => getOrderableDbInstanceResult.LicenseModel)),
MultiAz = false,
Password = "avoid-plaintext-passwords",
Username = "test",
StorageEncrypted = true,
});
var test_replica = new Aws.Rds.Instance("test-replica", new()
{
ReplicateSourceDb = @default.Identifier,
ReplicaMode = "mounted",
AutoMinorVersionUpgrade = false,
CustomIamInstanceProfile = "AWSRDSCustomInstanceProfile",
BackupRetentionPeriod = 7,
Identifier = "ee-instance-replica",
InstanceClass = custom_oracle.Apply(custom_oracle => custom_oracle.Apply(getOrderableDbInstanceResult => getOrderableDbInstanceResult.InstanceClass)).Apply(System.Enum.Parse<Aws.Rds.InstanceType>),
KmsKeyId = byId.Apply(getKeyResult => getKeyResult.Arn),
MultiAz = false,
SkipFinalSnapshot = true,
StorageEncrypted = true,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.rds.RdsFunctions;
import com.pulumi.aws.rds.inputs.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) {
// Lookup the available instance classes for the custom engine for the region being operated in
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.xlarge",
"db.r5.2xlarge",
"db.r5.4xlarge")
.build());
// The RDS instance resource requires an ARN. Look up the ARN of the KMS key associated with the CEV.
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(dbSubnetGroupName)
.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)
.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)
.build());
}
}
resources:
default:
type: aws:rds:Instance
properties:
allocatedStorage: 50
autoMinorVersionUpgrade: false # Custom for Oracle does not support minor version upgrades
customIamInstanceProfile: AWSRDSCustomInstanceProfile
backupRetentionPeriod: 7
dbSubnetGroupName: ${dbSubnetGroupName}
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
test-replica:
type: aws:rds:Instance
properties:
replicateSourceDb: ${default.identifier}
replicaMode: mounted
autoMinorVersionUpgrade: false
customIamInstanceProfile: AWSRDSCustomInstanceProfile
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
variables:
# Lookup the available instance classes for the custom engine for the region being operated in
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.xlarge
- db.r5.2xlarge
- db.r5.4xlarge
# The RDS instance resource requires an ARN. Look up the ARN of the KMS key associated with the CEV.
byId:
fn::invoke:
Function: aws:kms:getKey
Arguments:
keyId: example-ef278353ceba4a5a97de6784565b9f78
RDS Custom for SQL Server
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
// Lookup the available instance classes for the custom engine for the region being operated in
const custom-sqlserver = aws.rds.getOrderableDbInstance({
engine: "custom-sqlserver-se",
engineVersion: "15.00.4249.2.v1",
storageType: "gp3",
preferredInstanceClasses: [
"db.r5.xlarge",
"db.r5.2xlarge",
"db.r5.4xlarge",
],
});
// The RDS instance resource requires an ARN. Look up the ARN of the KMS key.
const byId = aws.kms.getKey({
keyId: "example-ef278353ceba4a5a97de6784565b9f78",
});
const example = new aws.rds.Instance("example", {
allocatedStorage: 500,
autoMinorVersionUpgrade: false,
customIamInstanceProfile: "AWSRDSCustomSQLServerInstanceProfile",
backupRetentionPeriod: 7,
dbSubnetGroupName: dbSubnetGroupName,
engine: custom_sqlserver.then(custom_sqlserver => custom_sqlserver.engine),
engineVersion: custom_sqlserver.then(custom_sqlserver => custom_sqlserver.engineVersion),
identifier: "sql-instance-demo",
instanceClass: custom_sqlserver.then(custom_sqlserver => custom_sqlserver.instanceClass).apply((x) => aws.rds.InstanceType[x]),
kmsKeyId: byId.then(byId => byId.arn),
multiAz: false,
password: "avoid-plaintext-passwords",
storageEncrypted: true,
username: "test",
});
import pulumi
import pulumi_aws as aws
# Lookup the available instance classes for the custom engine for the region being operated in
custom_sqlserver = aws.rds.get_orderable_db_instance(engine="custom-sqlserver-se",
engine_version="15.00.4249.2.v1",
storage_type="gp3",
preferred_instance_classes=[
"db.r5.xlarge",
"db.r5.2xlarge",
"db.r5.4xlarge",
])
# The RDS instance resource requires an ARN. Look up the ARN of the KMS key.
by_id = aws.kms.get_key(key_id="example-ef278353ceba4a5a97de6784565b9f78")
example = aws.rds.Instance("example",
allocated_storage=500,
auto_minor_version_upgrade=False,
custom_iam_instance_profile="AWSRDSCustomSQLServerInstanceProfile",
backup_retention_period=7,
db_subnet_group_name=db_subnet_group_name,
engine=custom_sqlserver.engine,
engine_version=custom_sqlserver.engine_version,
identifier="sql-instance-demo",
instance_class=custom_sqlserver.instance_class.apply(lambda x: aws.rds.InstanceType(x)),
kms_key_id=by_id.arn,
multi_az=False,
password="avoid-plaintext-passwords",
storage_encrypted=True,
username="test")
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 {
// Lookup the available instance classes for the custom engine for the region being operated in
custom_sqlserver, err := rds.GetOrderableDbInstance(ctx, &rds.GetOrderableDbInstanceArgs{
Engine: "custom-sqlserver-se",
EngineVersion: pulumi.StringRef("15.00.4249.2.v1"),
StorageType: pulumi.StringRef("gp3"),
PreferredInstanceClasses: []string{
"db.r5.xlarge",
"db.r5.2xlarge",
"db.r5.4xlarge",
},
}, nil)
if err != nil {
return err
}
// The RDS instance resource requires an ARN. Look up the ARN of the KMS key.
byId, err := kms.LookupKey(ctx, &kms.LookupKeyArgs{
KeyId: "example-ef278353ceba4a5a97de6784565b9f78",
}, nil)
if err != nil {
return err
}
_, err = rds.NewInstance(ctx, "example", &rds.InstanceArgs{
AllocatedStorage: pulumi.Int(500),
AutoMinorVersionUpgrade: pulumi.Bool(false),
CustomIamInstanceProfile: pulumi.String("AWSRDSCustomSQLServerInstanceProfile"),
BackupRetentionPeriod: pulumi.Int(7),
DbSubnetGroupName: pulumi.Any(dbSubnetGroupName),
Engine: pulumi.String(custom_sqlserver.Engine),
EngineVersion: pulumi.String(custom_sqlserver.EngineVersion),
Identifier: pulumi.String("sql-instance-demo"),
InstanceClass: custom_sqlserver.InstanceClass.ApplyT(func(x *string) rds.InstanceType { return rds.InstanceType(*x) }).(rds.InstanceTypeOutput),
KmsKeyId: pulumi.String(byId.Arn),
MultiAz: pulumi.Bool(false),
Password: pulumi.String("avoid-plaintext-passwords"),
StorageEncrypted: pulumi.Bool(true),
Username: pulumi.String("test"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
// Lookup the available instance classes for the custom engine for the region being operated in
var custom_sqlserver = Aws.Rds.GetOrderableDbInstance.Invoke(new()
{
Engine = "custom-sqlserver-se",
EngineVersion = "15.00.4249.2.v1",
StorageType = "gp3",
PreferredInstanceClasses = new[]
{
"db.r5.xlarge",
"db.r5.2xlarge",
"db.r5.4xlarge",
},
});
// The RDS instance resource requires an ARN. Look up the ARN of the KMS key.
var byId = Aws.Kms.GetKey.Invoke(new()
{
KeyId = "example-ef278353ceba4a5a97de6784565b9f78",
});
var example = new Aws.Rds.Instance("example", new()
{
AllocatedStorage = 500,
AutoMinorVersionUpgrade = false,
CustomIamInstanceProfile = "AWSRDSCustomSQLServerInstanceProfile",
BackupRetentionPeriod = 7,
DbSubnetGroupName = dbSubnetGroupName,
Engine = custom_sqlserver.Apply(custom_sqlserver => custom_sqlserver.Apply(getOrderableDbInstanceResult => getOrderableDbInstanceResult.Engine)),
EngineVersion = custom_sqlserver.Apply(custom_sqlserver => custom_sqlserver.Apply(getOrderableDbInstanceResult => getOrderableDbInstanceResult.EngineVersion)),
Identifier = "sql-instance-demo",
InstanceClass = custom_sqlserver.Apply(custom_sqlserver => custom_sqlserver.Apply(getOrderableDbInstanceResult => getOrderableDbInstanceResult.InstanceClass)).Apply(System.Enum.Parse<Aws.Rds.InstanceType>),
KmsKeyId = byId.Apply(getKeyResult => getKeyResult.Arn),
MultiAz = false,
Password = "avoid-plaintext-passwords",
StorageEncrypted = true,
Username = "test",
});
});
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) {
// Lookup the available instance classes for the custom engine for the region being operated in
final var custom-sqlserver = RdsFunctions.getOrderableDbInstance(GetOrderableDbInstanceArgs.builder()
.engine("custom-sqlserver-se")
.engineVersion("15.00.4249.2.v1")
.storageType("gp3")
.preferredInstanceClasses(
"db.r5.xlarge",
"db.r5.2xlarge",
"db.r5.4xlarge")
.build());
// The RDS instance resource requires an ARN. Look up the ARN of the KMS key.
final var byId = KmsFunctions.getKey(GetKeyArgs.builder()
.keyId("example-ef278353ceba4a5a97de6784565b9f78")
.build());
var example = new Instance("example", InstanceArgs.builder()
.allocatedStorage(500)
.autoMinorVersionUpgrade(false)
.customIamInstanceProfile("AWSRDSCustomSQLServerInstanceProfile")
.backupRetentionPeriod(7)
.dbSubnetGroupName(dbSubnetGroupName)
.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")
.storageEncrypted(true)
.username("test")
.build());
}
}
resources:
example:
type: aws:rds:Instance
properties:
allocatedStorage: 500
autoMinorVersionUpgrade: false # Custom for SQL Server does not support minor version upgrades
customIamInstanceProfile: AWSRDSCustomSQLServerInstanceProfile
backupRetentionPeriod: 7
dbSubnetGroupName: ${dbSubnetGroupName}
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 support multi-az
password: avoid-plaintext-passwords
storageEncrypted: true
username: test
variables:
# Lookup the available instance classes for the custom engine for the region being operated in
custom-sqlserver:
fn::invoke:
Function: aws:rds:getOrderableDbInstance
Arguments:
engine: custom-sqlserver-se
engineVersion: 15.00.4249.2.v1
storageType: gp3
preferredInstanceClasses:
- db.r5.xlarge
- db.r5.2xlarge
- db.r5.4xlarge
# The RDS instance resource requires an ARN. Look up the ARN of the KMS key.
byId:
fn::invoke:
Function: aws:kms:getKey
Arguments:
keyId: example-ef278353ceba4a5a97de6784565b9f78
RDS Db2 Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
// Lookup the default version for the engine. Db2 Standard Edition is `db2-se`, Db2 Advanced Edition is `db2-ae`.
const default = aws.rds.getEngineVersion({
engine: "db2-se",
});
// Lookup the available instance classes for the engine in the region being operated in
const example = Promise.all([_default, _default]).then(([_default, _default1]) => aws.rds.getOrderableDbInstance({
engine: _default.engine,
engineVersion: _default1.version,
licenseModel: "bring-your-own-license",
storageType: "gp3",
preferredInstanceClasses: [
"db.t3.small",
"db.r6i.large",
"db.m6i.large",
],
}));
// The RDS Db2 instance resource requires licensing information. Create a new parameter group using the default paramater group as a source, and set license information.
const exampleParameterGroup = new aws.rds.ParameterGroup("example", {
name: "db-db2-params",
family: _default.then(_default => _default.parameterGroupFamily),
parameters: [
{
applyMethod: "immediate",
name: "rds.ibm_customer_id",
value: "0",
},
{
applyMethod: "immediate",
name: "rds.ibm_site_id",
value: "0",
},
],
});
// Create the RDS Db2 instance, use the data sources defined to set attributes
const exampleInstance = new aws.rds.Instance("example", {
allocatedStorage: 100,
backupRetentionPeriod: 7,
dbName: "test",
engine: example.then(example => example.engine),
engineVersion: example.then(example => example.engineVersion),
identifier: "db2-instance-demo",
instanceClass: example.then(example => example.instanceClass).apply((x) => aws.rds.InstanceType[x]),
parameterGroupName: exampleParameterGroup.name,
password: "avoid-plaintext-passwords",
username: "test",
});
import pulumi
import pulumi_aws as aws
# Lookup the default version for the engine. Db2 Standard Edition is `db2-se`, Db2 Advanced Edition is `db2-ae`.
default = aws.rds.get_engine_version(engine="db2-se")
# Lookup the available instance classes for the engine in the region being operated in
example = aws.rds.get_orderable_db_instance(engine=default.engine,
engine_version=default.version,
license_model="bring-your-own-license",
storage_type="gp3",
preferred_instance_classes=[
"db.t3.small",
"db.r6i.large",
"db.m6i.large",
])
# The RDS Db2 instance resource requires licensing information. Create a new parameter group using the default paramater group as a source, and set license information.
example_parameter_group = aws.rds.ParameterGroup("example",
name="db-db2-params",
family=default.parameter_group_family,
parameters=[
{
"applyMethod": "immediate",
"name": "rds.ibm_customer_id",
"value": "0",
},
{
"applyMethod": "immediate",
"name": "rds.ibm_site_id",
"value": "0",
},
])
# Create the RDS Db2 instance, use the data sources defined to set attributes
example_instance = aws.rds.Instance("example",
allocated_storage=100,
backup_retention_period=7,
db_name="test",
engine=example.engine,
engine_version=example.engine_version,
identifier="db2-instance-demo",
instance_class=example.instance_class.apply(lambda x: aws.rds.InstanceType(x)),
parameter_group_name=example_parameter_group.name,
password="avoid-plaintext-passwords",
username="test")
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/rds"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
// Lookup the default version for the engine. Db2 Standard Edition is `db2-se`, Db2 Advanced Edition is `db2-ae`.
_default, err := rds.GetEngineVersion(ctx, &rds.GetEngineVersionArgs{
Engine: "db2-se",
}, nil)
if err != nil {
return err
}
// Lookup the available instance classes for the engine in the region being operated in
example, err := rds.GetOrderableDbInstance(ctx, &rds.GetOrderableDbInstanceArgs{
Engine: _default.Engine,
EngineVersion: pulumi.StringRef(_default.Version),
LicenseModel: pulumi.StringRef("bring-your-own-license"),
StorageType: pulumi.StringRef("gp3"),
PreferredInstanceClasses: []string{
"db.t3.small",
"db.r6i.large",
"db.m6i.large",
},
}, nil)
if err != nil {
return err
}
// The RDS Db2 instance resource requires licensing information. Create a new parameter group using the default paramater group as a source, and set license information.
exampleParameterGroup, err := rds.NewParameterGroup(ctx, "example", &rds.ParameterGroupArgs{
Name: pulumi.String("db-db2-params"),
Family: pulumi.String(_default.ParameterGroupFamily),
Parameters: rds.ParameterGroupParameterArray{
&rds.ParameterGroupParameterArgs{
ApplyMethod: pulumi.String("immediate"),
Name: pulumi.String("rds.ibm_customer_id"),
Value: pulumi.String("0"),
},
&rds.ParameterGroupParameterArgs{
ApplyMethod: pulumi.String("immediate"),
Name: pulumi.String("rds.ibm_site_id"),
Value: pulumi.String("0"),
},
},
})
if err != nil {
return err
}
// Create the RDS Db2 instance, use the data sources defined to set attributes
_, err = rds.NewInstance(ctx, "example", &rds.InstanceArgs{
AllocatedStorage: pulumi.Int(100),
BackupRetentionPeriod: pulumi.Int(7),
DbName: pulumi.String("test"),
Engine: pulumi.String(example.Engine),
EngineVersion: pulumi.String(example.EngineVersion),
Identifier: pulumi.String("db2-instance-demo"),
InstanceClass: example.InstanceClass.ApplyT(func(x *string) rds.InstanceType { return rds.InstanceType(*x) }).(rds.InstanceTypeOutput),
ParameterGroupName: exampleParameterGroup.Name,
Password: pulumi.String("avoid-plaintext-passwords"),
Username: pulumi.String("test"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
// Lookup the default version for the engine. Db2 Standard Edition is `db2-se`, Db2 Advanced Edition is `db2-ae`.
var @default = Aws.Rds.GetEngineVersion.Invoke(new()
{
Engine = "db2-se",
});
// Lookup the available instance classes for the engine in the region being operated in
var example = Aws.Rds.GetOrderableDbInstance.Invoke(new()
{
Engine = @default.Apply(getEngineVersionResult => getEngineVersionResult.Engine),
EngineVersion = @default.Apply(getEngineVersionResult => getEngineVersionResult.Version),
LicenseModel = "bring-your-own-license",
StorageType = "gp3",
PreferredInstanceClasses = new[]
{
"db.t3.small",
"db.r6i.large",
"db.m6i.large",
},
});
// The RDS Db2 instance resource requires licensing information. Create a new parameter group using the default paramater group as a source, and set license information.
var exampleParameterGroup = new Aws.Rds.ParameterGroup("example", new()
{
Name = "db-db2-params",
Family = @default.Apply(@default => @default.Apply(getEngineVersionResult => getEngineVersionResult.ParameterGroupFamily)),
Parameters = new[]
{
new Aws.Rds.Inputs.ParameterGroupParameterArgs
{
ApplyMethod = "immediate",
Name = "rds.ibm_customer_id",
Value = "0",
},
new Aws.Rds.Inputs.ParameterGroupParameterArgs
{
ApplyMethod = "immediate",
Name = "rds.ibm_site_id",
Value = "0",
},
},
});
// Create the RDS Db2 instance, use the data sources defined to set attributes
var exampleInstance = new Aws.Rds.Instance("example", new()
{
AllocatedStorage = 100,
BackupRetentionPeriod = 7,
DbName = "test",
Engine = example.Apply(getOrderableDbInstanceResult => getOrderableDbInstanceResult.Engine),
EngineVersion = example.Apply(getOrderableDbInstanceResult => getOrderableDbInstanceResult.EngineVersion),
Identifier = "db2-instance-demo",
InstanceClass = example.Apply(getOrderableDbInstanceResult => getOrderableDbInstanceResult.InstanceClass).Apply(System.Enum.Parse<Aws.Rds.InstanceType>),
ParameterGroupName = exampleParameterGroup.Name,
Password = "avoid-plaintext-passwords",
Username = "test",
});
});
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.GetEngineVersionArgs;
import com.pulumi.aws.rds.inputs.GetOrderableDbInstanceArgs;
import com.pulumi.aws.rds.ParameterGroup;
import com.pulumi.aws.rds.ParameterGroupArgs;
import com.pulumi.aws.rds.inputs.ParameterGroupParameterArgs;
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) {
// Lookup the default version for the engine. Db2 Standard Edition is `db2-se`, Db2 Advanced Edition is `db2-ae`.
final var default = RdsFunctions.getEngineVersion(GetEngineVersionArgs.builder()
.engine("db2-se")
.build());
// Lookup the available instance classes for the engine in the region being operated in
final var example = RdsFunctions.getOrderableDbInstance(GetOrderableDbInstanceArgs.builder()
.engine(default_.engine())
.engineVersion(default_.version())
.licenseModel("bring-your-own-license")
.storageType("gp3")
.preferredInstanceClasses(
"db.t3.small",
"db.r6i.large",
"db.m6i.large")
.build());
// The RDS Db2 instance resource requires licensing information. Create a new parameter group using the default paramater group as a source, and set license information.
var exampleParameterGroup = new ParameterGroup("exampleParameterGroup", ParameterGroupArgs.builder()
.name("db-db2-params")
.family(default_.parameterGroupFamily())
.parameters(
ParameterGroupParameterArgs.builder()
.applyMethod("immediate")
.name("rds.ibm_customer_id")
.value(0)
.build(),
ParameterGroupParameterArgs.builder()
.applyMethod("immediate")
.name("rds.ibm_site_id")
.value(0)
.build())
.build());
// Create the RDS Db2 instance, use the data sources defined to set attributes
var exampleInstance = new Instance("exampleInstance", InstanceArgs.builder()
.allocatedStorage(100)
.backupRetentionPeriod(7)
.dbName("test")
.engine(example.applyValue(getOrderableDbInstanceResult -> getOrderableDbInstanceResult.engine()))
.engineVersion(example.applyValue(getOrderableDbInstanceResult -> getOrderableDbInstanceResult.engineVersion()))
.identifier("db2-instance-demo")
.instanceClass(example.applyValue(getOrderableDbInstanceResult -> getOrderableDbInstanceResult.instanceClass()))
.parameterGroupName(exampleParameterGroup.name())
.password("avoid-plaintext-passwords")
.username("test")
.build());
}
}
resources:
# The RDS Db2 instance resource requires licensing information. Create a new parameter group using the default paramater group as a source, and set license information.
exampleParameterGroup:
type: aws:rds:ParameterGroup
name: example
properties:
name: db-db2-params
family: ${default.parameterGroupFamily}
parameters:
- applyMethod: immediate
name: rds.ibm_customer_id
value: 0
- applyMethod: immediate
name: rds.ibm_site_id
value: 0
# Create the RDS Db2 instance, use the data sources defined to set attributes
exampleInstance:
type: aws:rds:Instance
name: example
properties:
allocatedStorage: 100
backupRetentionPeriod: 7
dbName: test
engine: ${example.engine}
engineVersion: ${example.engineVersion}
identifier: db2-instance-demo
instanceClass: ${example.instanceClass}
parameterGroupName: ${exampleParameterGroup.name}
password: avoid-plaintext-passwords
username: test
variables:
# Lookup the default version for the engine. Db2 Standard Edition is `db2-se`, Db2 Advanced Edition is `db2-ae`.
default:
fn::invoke:
Function: aws:rds:getEngineVersion
Arguments:
engine: db2-se
# Lookup the available instance classes for the engine in the region being operated in
example:
fn::invoke:
Function: aws:rds:getOrderableDbInstance
Arguments:
engine: ${default.engine}
engineVersion: ${default.version}
licenseModel: bring-your-own-license
storageType: gp3
preferredInstanceClasses:
- db.t3.small
- db.r6i.large
- db.m6i.large
Storage Autoscaling
To enable Storage Autoscaling with instances that support the feature, define the max_allocated_storage argument higher than the allocated_storage argument. This provider will automatically hide differences with the allocated_storage argument value if autoscaling occurs.
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.rds.Instance("example", {
allocatedStorage: 50,
maxAllocatedStorage: 100,
});
import pulumi
import pulumi_aws as aws
example = aws.rds.Instance("example",
allocated_storage=50,
max_allocated_storage=100)
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
})
}
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 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());
}
}
resources:
example:
type: aws:rds:Instance
properties:
allocatedStorage: 50
maxAllocatedStorage: 100
Managed Master Passwords via Secrets Manager, default KMS Key
More information about RDS/Aurora Aurora integrates with Secrets Manager to manage master user passwords for your DB clusters can be found in the RDS User Guide and Aurora User Guide.
You can specify the manage_master_user_password attribute to enable managing the master password with Secrets Manager. You can also update an existing cluster to use Secrets Manager by specify the manage_master_user_password attribute and removing the password attribute (removal is required).
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: "8.0",
instanceClass: aws.rds.InstanceType.T3_Micro,
manageMasterUserPassword: true,
username: "foo",
parameterGroupName: "default.mysql8.0",
});
import pulumi
import pulumi_aws as aws
default = aws.rds.Instance("default",
allocated_storage=10,
db_name="mydb",
engine="mysql",
engine_version="8.0",
instance_class=aws.rds.InstanceType.T3_MICRO,
manage_master_user_password=True,
username="foo",
parameter_group_name="default.mysql8.0")
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("8.0"),
InstanceClass: pulumi.String(rds.InstanceType_T3_Micro),
ManageMasterUserPassword: pulumi.Bool(true),
Username: pulumi.String("foo"),
ParameterGroupName: pulumi.String("default.mysql8.0"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var @default = new Aws.Rds.Instance("default", new()
{
AllocatedStorage = 10,
DbName = "mydb",
Engine = "mysql",
EngineVersion = "8.0",
InstanceClass = Aws.Rds.InstanceType.T3_Micro,
ManageMasterUserPassword = true,
Username = "foo",
ParameterGroupName = "default.mysql8.0",
});
});
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("8.0")
.instanceClass("db.t3.micro")
.manageMasterUserPassword(true)
.username("foo")
.parameterGroupName("default.mysql8.0")
.build());
}
}
resources:
default:
type: aws:rds:Instance
properties:
allocatedStorage: 10
dbName: mydb
engine: mysql
engineVersion: '8.0'
instanceClass: db.t3.micro
manageMasterUserPassword: true
username: foo
parameterGroupName: default.mysql8.0
Managed Master Passwords via Secrets Manager, specific KMS Key
More information about RDS/Aurora Aurora integrates with Secrets Manager to manage master user passwords for your DB clusters can be found in the RDS User Guide and Aurora User Guide.
You can specify the master_user_secret_kms_key_id attribute to specify a specific KMS Key.
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.kms.Key("example", {description: "Example KMS Key"});
const _default = new aws.rds.Instance("default", {
allocatedStorage: 10,
dbName: "mydb",
engine: "mysql",
engineVersion: "8.0",
instanceClass: aws.rds.InstanceType.T3_Micro,
manageMasterUserPassword: true,
masterUserSecretKmsKeyId: example.keyId,
username: "foo",
parameterGroupName: "default.mysql8.0",
});
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="8.0",
instance_class=aws.rds.InstanceType.T3_MICRO,
manage_master_user_password=True,
master_user_secret_kms_key_id=example.key_id,
username="foo",
parameter_group_name="default.mysql8.0")
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("8.0"),
InstanceClass: pulumi.String(rds.InstanceType_T3_Micro),
ManageMasterUserPassword: pulumi.Bool(true),
MasterUserSecretKmsKeyId: example.KeyId,
Username: pulumi.String("foo"),
ParameterGroupName: pulumi.String("default.mysql8.0"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Kms.Key("example", new()
{
Description = "Example KMS Key",
});
var @default = new Aws.Rds.Instance("default", new()
{
AllocatedStorage = 10,
DbName = "mydb",
Engine = "mysql",
EngineVersion = "8.0",
InstanceClass = Aws.Rds.InstanceType.T3_Micro,
ManageMasterUserPassword = true,
MasterUserSecretKmsKeyId = example.KeyId,
Username = "foo",
ParameterGroupName = "default.mysql8.0",
});
});
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("8.0")
.instanceClass("db.t3.micro")
.manageMasterUserPassword(true)
.masterUserSecretKmsKeyId(example.keyId())
.username("foo")
.parameterGroupName("default.mysql8.0")
.build());
}
}
resources:
example:
type: aws:kms:Key
properties:
description: Example KMS Key
default:
type: aws:rds:Instance
properties:
allocatedStorage: 10
dbName: mydb
engine: mysql
engineVersion: '8.0'
instanceClass: db.t3.micro
manageMasterUserPassword: true
masterUserSecretKmsKeyId: ${example.keyId}
username: foo
parameterGroupName: default.mysql8.0
Create Instance Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);@overload
def Instance(resource_name: str,
args: InstanceArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Instance(resource_name: str,
opts: Optional[ResourceOptions] = None,
instance_class: Optional[Union[str, InstanceType]] = None,
identifier_prefix: Optional[str] = None,
db_name: 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,
kms_key_id: Optional[str] = None,
db_subnet_group_name: Optional[str] = None,
dedicated_log_volume: Optional[bool] = None,
delete_automated_backups: Optional[bool] = None,
deletion_protection: Optional[bool] = None,
domain: Optional[str] = None,
domain_auth_secret_arn: Optional[str] = None,
domain_dns_ips: Optional[Sequence[str]] = None,
domain_fqdn: Optional[str] = None,
domain_iam_role_name: Optional[str] = None,
domain_ou: 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,
license_model: Optional[str] = None,
allow_major_version_upgrade: Optional[bool] = None,
master_user_secret_kms_key_id: Optional[str] = None,
apply_immediately: Optional[bool] = None,
allocated_storage: Optional[int] = None,
maintenance_window: Optional[str] = None,
manage_master_user_password: Optional[bool] = None,
iops: Optional[int] = 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)func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)
public Instance(String name, InstanceArgs args)
public Instance(String name, InstanceArgs args, CustomResourceOptions options)
type: aws:rds:Instance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args InstanceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args InstanceArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args InstanceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args InstanceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args InstanceArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var exampleinstanceResourceResourceFromRdsinstance = new Aws.Rds.Instance("exampleinstanceResourceResourceFromRdsinstance", new()
{
InstanceClass = "string",
IdentifierPrefix = "string",
DbName = "string",
AutoMinorVersionUpgrade = false,
AvailabilityZone = "string",
BackupRetentionPeriod = 0,
BackupTarget = "string",
BackupWindow = "string",
BlueGreenUpdate = new Aws.Rds.Inputs.InstanceBlueGreenUpdateArgs
{
Enabled = false,
},
CaCertIdentifier = "string",
CharacterSetName = "string",
CopyTagsToSnapshot = false,
CustomIamInstanceProfile = "string",
CustomerOwnedIpEnabled = false,
KmsKeyId = "string",
DbSubnetGroupName = "string",
DedicatedLogVolume = false,
DeleteAutomatedBackups = false,
DeletionProtection = false,
Domain = "string",
DomainAuthSecretArn = "string",
DomainDnsIps = new[]
{
"string",
},
DomainFqdn = "string",
DomainIamRoleName = "string",
DomainOu = "string",
EnabledCloudwatchLogsExports = new[]
{
"string",
},
Engine = "string",
EngineVersion = "string",
FinalSnapshotIdentifier = "string",
IamDatabaseAuthenticationEnabled = false,
Identifier = "string",
LicenseModel = "string",
AllowMajorVersionUpgrade = false,
MasterUserSecretKmsKeyId = "string",
ApplyImmediately = false,
AllocatedStorage = 0,
MaintenanceWindow = "string",
ManageMasterUserPassword = false,
Iops = 0,
MaxAllocatedStorage = 0,
MonitoringInterval = 0,
MonitoringRoleArn = "string",
MultiAz = false,
NcharCharacterSetName = "string",
NetworkType = "string",
OptionGroupName = "string",
ParameterGroupName = "string",
Password = "string",
PerformanceInsightsEnabled = false,
PerformanceInsightsKmsKeyId = "string",
PerformanceInsightsRetentionPeriod = 0,
Port = 0,
PubliclyAccessible = false,
ReplicaMode = "string",
ReplicateSourceDb = "string",
RestoreToPointInTime = new Aws.Rds.Inputs.InstanceRestoreToPointInTimeArgs
{
RestoreTime = "string",
SourceDbInstanceAutomatedBackupsArn = "string",
SourceDbInstanceIdentifier = "string",
SourceDbiResourceId = "string",
UseLatestRestorableTime = false,
},
S3Import = new Aws.Rds.Inputs.InstanceS3ImportArgs
{
BucketName = "string",
IngestionRole = "string",
SourceEngine = "string",
SourceEngineVersion = "string",
BucketPrefix = "string",
},
SkipFinalSnapshot = false,
SnapshotIdentifier = "string",
StorageEncrypted = false,
StorageThroughput = 0,
StorageType = "string",
Tags =
{
{ "string", "string" },
},
Timezone = "string",
Username = "string",
VpcSecurityGroupIds = new[]
{
"string",
},
});
example, err := rds.NewInstance(ctx, "exampleinstanceResourceResourceFromRdsinstance", &rds.InstanceArgs{
InstanceClass: pulumi.String("string"),
IdentifierPrefix: pulumi.String("string"),
DbName: pulumi.String("string"),
AutoMinorVersionUpgrade: pulumi.Bool(false),
AvailabilityZone: pulumi.String("string"),
BackupRetentionPeriod: pulumi.Int(0),
BackupTarget: pulumi.String("string"),
BackupWindow: pulumi.String("string"),
BlueGreenUpdate: &rds.InstanceBlueGreenUpdateArgs{
Enabled: pulumi.Bool(false),
},
CaCertIdentifier: pulumi.String("string"),
CharacterSetName: pulumi.String("string"),
CopyTagsToSnapshot: pulumi.Bool(false),
CustomIamInstanceProfile: pulumi.String("string"),
CustomerOwnedIpEnabled: pulumi.Bool(false),
KmsKeyId: pulumi.String("string"),
DbSubnetGroupName: pulumi.String("string"),
DedicatedLogVolume: pulumi.Bool(false),
DeleteAutomatedBackups: pulumi.Bool(false),
DeletionProtection: pulumi.Bool(false),
Domain: pulumi.String("string"),
DomainAuthSecretArn: pulumi.String("string"),
DomainDnsIps: pulumi.StringArray{
pulumi.String("string"),
},
DomainFqdn: pulumi.String("string"),
DomainIamRoleName: pulumi.String("string"),
DomainOu: pulumi.String("string"),
EnabledCloudwatchLogsExports: pulumi.StringArray{
pulumi.String("string"),
},
Engine: pulumi.String("string"),
EngineVersion: pulumi.String("string"),
FinalSnapshotIdentifier: pulumi.String("string"),
IamDatabaseAuthenticationEnabled: pulumi.Bool(false),
Identifier: pulumi.String("string"),
LicenseModel: pulumi.String("string"),
AllowMajorVersionUpgrade: pulumi.Bool(false),
MasterUserSecretKmsKeyId: pulumi.String("string"),
ApplyImmediately: pulumi.Bool(false),
AllocatedStorage: pulumi.Int(0),
MaintenanceWindow: pulumi.String("string"),
ManageMasterUserPassword: pulumi.Bool(false),
Iops: pulumi.Int(0),
MaxAllocatedStorage: pulumi.Int(0),
MonitoringInterval: pulumi.Int(0),
MonitoringRoleArn: pulumi.String("string"),
MultiAz: pulumi.Bool(false),
NcharCharacterSetName: pulumi.String("string"),
NetworkType: pulumi.String("string"),
OptionGroupName: pulumi.String("string"),
ParameterGroupName: pulumi.String("string"),
Password: pulumi.String("string"),
PerformanceInsightsEnabled: pulumi.Bool(false),
PerformanceInsightsKmsKeyId: pulumi.String("string"),
PerformanceInsightsRetentionPeriod: pulumi.Int(0),
Port: pulumi.Int(0),
PubliclyAccessible: pulumi.Bool(false),
ReplicaMode: pulumi.String("string"),
ReplicateSourceDb: pulumi.String("string"),
RestoreToPointInTime: &rds.InstanceRestoreToPointInTimeArgs{
RestoreTime: pulumi.String("string"),
SourceDbInstanceAutomatedBackupsArn: pulumi.String("string"),
SourceDbInstanceIdentifier: pulumi.String("string"),
SourceDbiResourceId: pulumi.String("string"),
UseLatestRestorableTime: pulumi.Bool(false),
},
S3Import: &rds.InstanceS3ImportArgs{
BucketName: pulumi.String("string"),
IngestionRole: pulumi.String("string"),
SourceEngine: pulumi.String("string"),
SourceEngineVersion: pulumi.String("string"),
BucketPrefix: pulumi.String("string"),
},
SkipFinalSnapshot: pulumi.Bool(false),
SnapshotIdentifier: pulumi.String("string"),
StorageEncrypted: pulumi.Bool(false),
StorageThroughput: pulumi.Int(0),
StorageType: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
Timezone: pulumi.String("string"),
Username: pulumi.String("string"),
VpcSecurityGroupIds: pulumi.StringArray{
pulumi.String("string"),
},
})
var exampleinstanceResourceResourceFromRdsinstance = new Instance("exampleinstanceResourceResourceFromRdsinstance", InstanceArgs.builder()
.instanceClass("string")
.identifierPrefix("string")
.dbName("string")
.autoMinorVersionUpgrade(false)
.availabilityZone("string")
.backupRetentionPeriod(0)
.backupTarget("string")
.backupWindow("string")
.blueGreenUpdate(InstanceBlueGreenUpdateArgs.builder()
.enabled(false)
.build())
.caCertIdentifier("string")
.characterSetName("string")
.copyTagsToSnapshot(false)
.customIamInstanceProfile("string")
.customerOwnedIpEnabled(false)
.kmsKeyId("string")
.dbSubnetGroupName("string")
.dedicatedLogVolume(false)
.deleteAutomatedBackups(false)
.deletionProtection(false)
.domain("string")
.domainAuthSecretArn("string")
.domainDnsIps("string")
.domainFqdn("string")
.domainIamRoleName("string")
.domainOu("string")
.enabledCloudwatchLogsExports("string")
.engine("string")
.engineVersion("string")
.finalSnapshotIdentifier("string")
.iamDatabaseAuthenticationEnabled(false)
.identifier("string")
.licenseModel("string")
.allowMajorVersionUpgrade(false)
.masterUserSecretKmsKeyId("string")
.applyImmediately(false)
.allocatedStorage(0)
.maintenanceWindow("string")
.manageMasterUserPassword(false)
.iops(0)
.maxAllocatedStorage(0)
.monitoringInterval(0)
.monitoringRoleArn("string")
.multiAz(false)
.ncharCharacterSetName("string")
.networkType("string")
.optionGroupName("string")
.parameterGroupName("string")
.password("string")
.performanceInsightsEnabled(false)
.performanceInsightsKmsKeyId("string")
.performanceInsightsRetentionPeriod(0)
.port(0)
.publiclyAccessible(false)
.replicaMode("string")
.replicateSourceDb("string")
.restoreToPointInTime(InstanceRestoreToPointInTimeArgs.builder()
.restoreTime("string")
.sourceDbInstanceAutomatedBackupsArn("string")
.sourceDbInstanceIdentifier("string")
.sourceDbiResourceId("string")
.useLatestRestorableTime(false)
.build())
.s3Import(InstanceS3ImportArgs.builder()
.bucketName("string")
.ingestionRole("string")
.sourceEngine("string")
.sourceEngineVersion("string")
.bucketPrefix("string")
.build())
.skipFinalSnapshot(false)
.snapshotIdentifier("string")
.storageEncrypted(false)
.storageThroughput(0)
.storageType("string")
.tags(Map.of("string", "string"))
.timezone("string")
.username("string")
.vpcSecurityGroupIds("string")
.build());
exampleinstance_resource_resource_from_rdsinstance = aws.rds.Instance("exampleinstanceResourceResourceFromRdsinstance",
instance_class="string",
identifier_prefix="string",
db_name="string",
auto_minor_version_upgrade=False,
availability_zone="string",
backup_retention_period=0,
backup_target="string",
backup_window="string",
blue_green_update={
"enabled": False,
},
ca_cert_identifier="string",
character_set_name="string",
copy_tags_to_snapshot=False,
custom_iam_instance_profile="string",
customer_owned_ip_enabled=False,
kms_key_id="string",
db_subnet_group_name="string",
dedicated_log_volume=False,
delete_automated_backups=False,
deletion_protection=False,
domain="string",
domain_auth_secret_arn="string",
domain_dns_ips=["string"],
domain_fqdn="string",
domain_iam_role_name="string",
domain_ou="string",
enabled_cloudwatch_logs_exports=["string"],
engine="string",
engine_version="string",
final_snapshot_identifier="string",
iam_database_authentication_enabled=False,
identifier="string",
license_model="string",
allow_major_version_upgrade=False,
master_user_secret_kms_key_id="string",
apply_immediately=False,
allocated_storage=0,
maintenance_window="string",
manage_master_user_password=False,
iops=0,
max_allocated_storage=0,
monitoring_interval=0,
monitoring_role_arn="string",
multi_az=False,
nchar_character_set_name="string",
network_type="string",
option_group_name="string",
parameter_group_name="string",
password="string",
performance_insights_enabled=False,
performance_insights_kms_key_id="string",
performance_insights_retention_period=0,
port=0,
publicly_accessible=False,
replica_mode="string",
replicate_source_db="string",
restore_to_point_in_time={
"restoreTime": "string",
"sourceDbInstanceAutomatedBackupsArn": "string",
"sourceDbInstanceIdentifier": "string",
"sourceDbiResourceId": "string",
"useLatestRestorableTime": False,
},
s3_import={
"bucketName": "string",
"ingestionRole": "string",
"sourceEngine": "string",
"sourceEngineVersion": "string",
"bucketPrefix": "string",
},
skip_final_snapshot=False,
snapshot_identifier="string",
storage_encrypted=False,
storage_throughput=0,
storage_type="string",
tags={
"string": "string",
},
timezone="string",
username="string",
vpc_security_group_ids=["string"])
const exampleinstanceResourceResourceFromRdsinstance = new aws.rds.Instance("exampleinstanceResourceResourceFromRdsinstance", {
instanceClass: "string",
identifierPrefix: "string",
dbName: "string",
autoMinorVersionUpgrade: false,
availabilityZone: "string",
backupRetentionPeriod: 0,
backupTarget: "string",
backupWindow: "string",
blueGreenUpdate: {
enabled: false,
},
caCertIdentifier: "string",
characterSetName: "string",
copyTagsToSnapshot: false,
customIamInstanceProfile: "string",
customerOwnedIpEnabled: false,
kmsKeyId: "string",
dbSubnetGroupName: "string",
dedicatedLogVolume: false,
deleteAutomatedBackups: false,
deletionProtection: false,
domain: "string",
domainAuthSecretArn: "string",
domainDnsIps: ["string"],
domainFqdn: "string",
domainIamRoleName: "string",
domainOu: "string",
enabledCloudwatchLogsExports: ["string"],
engine: "string",
engineVersion: "string",
finalSnapshotIdentifier: "string",
iamDatabaseAuthenticationEnabled: false,
identifier: "string",
licenseModel: "string",
allowMajorVersionUpgrade: false,
masterUserSecretKmsKeyId: "string",
applyImmediately: false,
allocatedStorage: 0,
maintenanceWindow: "string",
manageMasterUserPassword: false,
iops: 0,
maxAllocatedStorage: 0,
monitoringInterval: 0,
monitoringRoleArn: "string",
multiAz: false,
ncharCharacterSetName: "string",
networkType: "string",
optionGroupName: "string",
parameterGroupName: "string",
password: "string",
performanceInsightsEnabled: false,
performanceInsightsKmsKeyId: "string",
performanceInsightsRetentionPeriod: 0,
port: 0,
publiclyAccessible: false,
replicaMode: "string",
replicateSourceDb: "string",
restoreToPointInTime: {
restoreTime: "string",
sourceDbInstanceAutomatedBackupsArn: "string",
sourceDbInstanceIdentifier: "string",
sourceDbiResourceId: "string",
useLatestRestorableTime: false,
},
s3Import: {
bucketName: "string",
ingestionRole: "string",
sourceEngine: "string",
sourceEngineVersion: "string",
bucketPrefix: "string",
},
skipFinalSnapshot: false,
snapshotIdentifier: "string",
storageEncrypted: false,
storageThroughput: 0,
storageType: "string",
tags: {
string: "string",
},
timezone: "string",
username: "string",
vpcSecurityGroupIds: ["string"],
});
type: aws:rds:Instance
properties:
allocatedStorage: 0
allowMajorVersionUpgrade: false
applyImmediately: false
autoMinorVersionUpgrade: false
availabilityZone: string
backupRetentionPeriod: 0
backupTarget: string
backupWindow: string
blueGreenUpdate:
enabled: false
caCertIdentifier: string
characterSetName: string
copyTagsToSnapshot: false
customIamInstanceProfile: string
customerOwnedIpEnabled: false
dbName: string
dbSubnetGroupName: string
dedicatedLogVolume: false
deleteAutomatedBackups: false
deletionProtection: false
domain: string
domainAuthSecretArn: string
domainDnsIps:
- string
domainFqdn: string
domainIamRoleName: string
domainOu: string
enabledCloudwatchLogsExports:
- string
engine: string
engineVersion: string
finalSnapshotIdentifier: string
iamDatabaseAuthenticationEnabled: false
identifier: string
identifierPrefix: string
instanceClass: string
iops: 0
kmsKeyId: string
licenseModel: string
maintenanceWindow: string
manageMasterUserPassword: false
masterUserSecretKmsKeyId: string
maxAllocatedStorage: 0
monitoringInterval: 0
monitoringRoleArn: string
multiAz: false
ncharCharacterSetName: string
networkType: string
optionGroupName: string
parameterGroupName: string
password: string
performanceInsightsEnabled: false
performanceInsightsKmsKeyId: string
performanceInsightsRetentionPeriod: 0
port: 0
publiclyAccessible: false
replicaMode: string
replicateSourceDb: string
restoreToPointInTime:
restoreTime: string
sourceDbInstanceAutomatedBackupsArn: string
sourceDbInstanceIdentifier: string
sourceDbiResourceId: string
useLatestRestorableTime: false
s3Import:
bucketName: string
bucketPrefix: string
ingestionRole: string
sourceEngine: string
sourceEngineVersion: string
skipFinalSnapshot: false
snapshotIdentifier: string
storageEncrypted: false
storageThroughput: 0
storageType: string
tags:
string: string
timezone: string
username: string
vpcSecurityGroupIds:
- string
Instance Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
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_storageis configured, this argument represents the initial storage allocation and differences from the configuration will be ignored automatically when Storage Autoscaling occurs. Ifreplicate_source_dbis 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
0and35. Default is0. Must be greater than0if 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_updatebelow. - 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.
Cannot be set with
replicate_source_db,restore_to_point_in_time,s3_import, orsnapshot_identifier. - bool
- Copy all Instance
tagsto 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_dbattribute 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
defaultVPC, 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 constraints. - Dedicated
Log boolVolume - Use a dedicated log volume (DLV) for the DB instance. Requires Provisioned IOPS. See the AWS documentation for more details.
- 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. Conflicts with
domain_fqdn,domain_ou,domain_auth_secret_arnand adomain_dns_ips. - Domain
Auth stringSecret Arn - The ARN for the Secrets Manager secret with the self managed Active Directory credentials for the user joining the domain. Conflicts with
domainanddomain_iam_role_name. - Domain
Dns List<string>Ips - The IPv4 DNS IP addresses of your primary and secondary self managed Active Directory domain controllers. Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list. Conflicts with
domainanddomain_iam_role_name. - Domain
Fqdn string - The fully qualified domain name (FQDN) of the self managed Active Directory domain. Conflicts with
domainanddomain_iam_role_name. - Domain
Iam stringRole Name - The name of the IAM role to be used when making API calls to the Directory Service. Conflicts with
domain_fqdn,domain_ou,domain_auth_secret_arnand adomain_dns_ips. - Domain
Ou string - The self managed Active Directory organizational unit for your DB instance to join. Conflicts with
domainanddomain_iam_role_name. - Enabled
Cloudwatch List<string>Logs Exports - Set of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. For supported values, see the EnableCloudwatchLogsExports.member.N parameter in API action CreateDBInstance.
- 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_upgradeis enabled, you can provide a prefix of the version such as8.0(for8.0.36). 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_snapshotis 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_timeis 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_typeis"io1"or"gp3". Cannot be specified for gp3 storage if theallocated_storagevalue is below a per-enginethreshold. 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 - License model information for this DB instance. Valid values for this field are as follows:
- RDS for MariaDB:
general-public-license - RDS for Microsoft SQL Server:
license-included - RDS for MySQL:
general-public-license - RDS for Oracle:
bring-your-own-license | license-included - RDS for PostgreSQL:
postgresql-license
- RDS for MariaDB:
- 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
passwordis 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_storageor0to 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
- 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_passwordis set to true or unless asnapshot_identifierorreplicate_source_dbis provided ormanage_master_user_passwordis 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_passwordis 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_enabledneeds 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_enabledneeds 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
mountedoropen-read-onlymode. This attribute is only supported by Oracle instances. Oracle replicas operate inopen-read-onlymode 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
identifierof 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
identifierargument 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_idwith a valid ARN. The default isfalseif not specified. - Storage
Throughput int - The storage throughput value for the DB instance. Can only be set when
storage_typeis"gp3". Cannot be specified if theallocated_storagevalue is below a per-enginethreshold. 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
iopsindependently) or "io1" (provisioned IOPS SSD). The default is "io1" ifiopsis specified, "gp2" if not. - Dictionary<string, string>
- A map of tags to assign to the resource. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Timezone string
- Time zone of the DB instance.
timezoneis currently only supported by Microsoft SQL Server. Thetimezonecan only be set on creation. See MSSQL User Guide for more information. - Username string
- (Required unless a
snapshot_identifierorreplicate_source_dbis 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_storageis configured, this argument represents the initial storage allocation and differences from the configuration will be ignored automatically when Storage Autoscaling occurs. Ifreplicate_source_dbis 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
0and35. Default is0. Must be greater than0if 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_updatebelow. - 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.
Cannot be set with
replicate_source_db,restore_to_point_in_time,s3_import, orsnapshot_identifier. - bool
- Copy all Instance
tagsto 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_dbattribute 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
defaultVPC, 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 constraints. - Dedicated
Log boolVolume - Use a dedicated log volume (DLV) for the DB instance. Requires Provisioned IOPS. See the AWS documentation for more details.
- 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. Conflicts with
domain_fqdn,domain_ou,domain_auth_secret_arnand adomain_dns_ips. - Domain
Auth stringSecret Arn - The ARN for the Secrets Manager secret with the self managed Active Directory credentials for the user joining the domain. Conflicts with
domainanddomain_iam_role_name. - Domain
Dns []stringIps - The IPv4 DNS IP addresses of your primary and secondary self managed Active Directory domain controllers. Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list. Conflicts with
domainanddomain_iam_role_name. - Domain
Fqdn string - The fully qualified domain name (FQDN) of the self managed Active Directory domain. Conflicts with
domainanddomain_iam_role_name. - Domain
Iam stringRole Name - The name of the IAM role to be used when making API calls to the Directory Service. Conflicts with
domain_fqdn,domain_ou,domain_auth_secret_arnand adomain_dns_ips. - Domain
Ou string - The self managed Active Directory organizational unit for your DB instance to join. Conflicts with
domainanddomain_iam_role_name. - Enabled
Cloudwatch []stringLogs Exports - Set of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. For supported values, see the EnableCloudwatchLogsExports.member.N parameter in API action CreateDBInstance.
- 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_upgradeis enabled, you can provide a prefix of the version such as8.0(for8.0.36). 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_snapshotis 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_timeis 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_typeis"io1"or"gp3". Cannot be specified for gp3 storage if theallocated_storagevalue is below a per-enginethreshold. 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 - License model information for this DB instance. Valid values for this field are as follows:
- RDS for MariaDB:
general-public-license - RDS for Microsoft SQL Server:
license-included - RDS for MySQL:
general-public-license - RDS for Oracle:
bring-your-own-license | license-included - RDS for PostgreSQL:
postgresql-license
- RDS for MariaDB:
- 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
passwordis 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_storageor0to 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
- 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_passwordis set to true or unless asnapshot_identifierorreplicate_source_dbis provided ormanage_master_user_passwordis 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_passwordis 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_enabledneeds 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_enabledneeds 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
mountedoropen-read-onlymode. This attribute is only supported by Oracle instances. Oracle replicas operate inopen-read-onlymode 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
identifierof 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
identifierargument 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_idwith a valid ARN. The default isfalseif not specified. - Storage
Throughput int - The storage throughput value for the DB instance. Can only be set when
storage_typeis"gp3". Cannot be specified if theallocated_storagevalue is below a per-enginethreshold. 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
iopsindependently) or "io1" (provisioned IOPS SSD). The default is "io1" ifiopsis specified, "gp2" if not. - map[string]string
- A map of tags to assign to the resource. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Timezone string
- Time zone of the DB instance.
timezoneis currently only supported by Microsoft SQL Server. Thetimezonecan only be set on creation. See MSSQL User Guide for more information. - Username string
- (Required unless a
snapshot_identifierorreplicate_source_dbis 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_storageis configured, this argument represents the initial storage allocation and differences from the configuration will be ignored automatically when Storage Autoscaling occurs. Ifreplicate_source_dbis 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
0and35. Default is0. Must be greater than0if 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_updatebelow. - 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.
Cannot be set with
replicate_source_db,restore_to_point_in_time,s3_import, orsnapshot_identifier. - Boolean
- Copy all Instance
tagsto 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_dbattribute 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
defaultVPC, 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 constraints. - dedicated
Log BooleanVolume - Use a dedicated log volume (DLV) for the DB instance. Requires Provisioned IOPS. See the AWS documentation for more details.
- 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. Conflicts with
domain_fqdn,domain_ou,domain_auth_secret_arnand adomain_dns_ips. - domain
Auth StringSecret Arn - The ARN for the Secrets Manager secret with the self managed Active Directory credentials for the user joining the domain. Conflicts with
domainanddomain_iam_role_name. - domain
Dns List<String>Ips - The IPv4 DNS IP addresses of your primary and secondary self managed Active Directory domain controllers. Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list. Conflicts with
domainanddomain_iam_role_name. - domain
Fqdn String - The fully qualified domain name (FQDN) of the self managed Active Directory domain. Conflicts with
domainanddomain_iam_role_name. - domain
Iam StringRole Name - The name of the IAM role to be used when making API calls to the Directory Service. Conflicts with
domain_fqdn,domain_ou,domain_auth_secret_arnand adomain_dns_ips. - domain
Ou String - The self managed Active Directory organizational unit for your DB instance to join. Conflicts with
domainanddomain_iam_role_name. - enabled
Cloudwatch List<String>Logs Exports - Set of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. For supported values, see the EnableCloudwatchLogsExports.member.N parameter in API action CreateDBInstance.
- 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_upgradeis enabled, you can provide a prefix of the version such as8.0(for8.0.36). 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_snapshotis 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_timeis 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_typeis"io1"or"gp3". Cannot be specified for gp3 storage if theallocated_storagevalue is below a per-enginethreshold. 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 - License model information for this DB instance. Valid values for this field are as follows:
- RDS for MariaDB:
general-public-license - RDS for Microsoft SQL Server:
license-included - RDS for MySQL:
general-public-license - RDS for Oracle:
bring-your-own-license | license-included - RDS for PostgreSQL:
postgresql-license
- RDS for MariaDB:
- 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
passwordis 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_storageor0to 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
- 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_passwordis set to true or unless asnapshot_identifierorreplicate_source_dbis provided ormanage_master_user_passwordis 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_passwordis 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_enabledneeds 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_enabledneeds 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
mountedoropen-read-onlymode. This attribute is only supported by Oracle instances. Oracle replicas operate inopen-read-onlymode 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
identifierof 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
identifierargument 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_idwith a valid ARN. The default isfalseif not specified. - storage
Throughput Integer - The storage throughput value for the DB instance. Can only be set when
storage_typeis"gp3". Cannot be specified if theallocated_storagevalue is below a per-enginethreshold. 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
iopsindependently) or "io1" (provisioned IOPS SSD). The default is "io1" ifiopsis specified, "gp2" if not. - Map<String,String>
- A map of tags to assign to the resource. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - timezone String
- Time zone of the DB instance.
timezoneis currently only supported by Microsoft SQL Server. Thetimezonecan only be set on creation. See MSSQL User Guide for more information. - username String
- (Required unless a
snapshot_identifierorreplicate_source_dbis 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_storageis configured, this argument represents the initial storage allocation and differences from the configuration will be ignored automatically when Storage Autoscaling occurs. Ifreplicate_source_dbis 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
0and35. Default is0. Must be greater than0if 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_updatebelow. - 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.
Cannot be set with
replicate_source_db,restore_to_point_in_time,s3_import, orsnapshot_identifier. - boolean
- Copy all Instance
tagsto 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_dbattribute 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
defaultVPC, 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 constraints. - dedicated
Log booleanVolume - Use a dedicated log volume (DLV) for the DB instance. Requires Provisioned IOPS. See the AWS documentation for more details.
- 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. Conflicts with
domain_fqdn,domain_ou,domain_auth_secret_arnand adomain_dns_ips. - domain
Auth stringSecret Arn - The ARN for the Secrets Manager secret with the self managed Active Directory credentials for the user joining the domain. Conflicts with
domainanddomain_iam_role_name. - domain
Dns string[]Ips - The IPv4 DNS IP addresses of your primary and secondary self managed Active Directory domain controllers. Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list. Conflicts with
domainanddomain_iam_role_name. - domain
Fqdn string - The fully qualified domain name (FQDN) of the self managed Active Directory domain. Conflicts with
domainanddomain_iam_role_name. - domain
Iam stringRole Name - The name of the IAM role to be used when making API calls to the Directory Service. Conflicts with
domain_fqdn,domain_ou,domain_auth_secret_arnand adomain_dns_ips. - domain
Ou string - The self managed Active Directory organizational unit for your DB instance to join. Conflicts with
domainanddomain_iam_role_name. - enabled
Cloudwatch string[]Logs Exports - Set of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. For supported values, see the EnableCloudwatchLogsExports.member.N parameter in API action CreateDBInstance.
- 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_upgradeis enabled, you can provide a prefix of the version such as8.0(for8.0.36). 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_snapshotis 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_timeis 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_typeis"io1"or"gp3". Cannot be specified for gp3 storage if theallocated_storagevalue is below a per-enginethreshold. 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 - License model information for this DB instance. Valid values for this field are as follows:
- RDS for MariaDB:
general-public-license - RDS for Microsoft SQL Server:
license-included - RDS for MySQL:
general-public-license - RDS for Oracle:
bring-your-own-license | license-included - RDS for PostgreSQL:
postgresql-license
- RDS for MariaDB:
- 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
passwordis 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_storageor0to 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
- 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_passwordis set to true or unless asnapshot_identifierorreplicate_source_dbis provided ormanage_master_user_passwordis 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_passwordis 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_enabledneeds 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_enabledneeds 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
mountedoropen-read-onlymode. This attribute is only supported by Oracle instances. Oracle replicas operate inopen-read-onlymode 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
identifierof 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
identifierargument 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_idwith a valid ARN. The default isfalseif not specified. - storage
Throughput number - The storage throughput value for the DB instance. Can only be set when
storage_typeis"gp3". Cannot be specified if theallocated_storagevalue is below a per-enginethreshold. 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
iopsindependently) or "io1" (provisioned IOPS SSD). The default is "io1" ifiopsis specified, "gp2" if not. - {[key: string]: string}
- A map of tags to assign to the resource. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - timezone string
- Time zone of the DB instance.
timezoneis currently only supported by Microsoft SQL Server. Thetimezonecan only be set on creation. See MSSQL User Guide for more information. - username string
- (Required unless a
snapshot_identifierorreplicate_source_dbis 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_storageis configured, this argument represents the initial storage allocation and differences from the configuration will be ignored automatically when Storage Autoscaling occurs. Ifreplicate_source_dbis 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
0and35. Default is0. Must be greater than0if 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_updatebelow. - 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.
Cannot be set with
replicate_source_db,restore_to_point_in_time,s3_import, orsnapshot_identifier. - bool
- Copy all Instance
tagsto 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_dbattribute 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
defaultVPC, 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 constraints. - dedicated_
log_ boolvolume - Use a dedicated log volume (DLV) for the DB instance. Requires Provisioned IOPS. See the AWS documentation for more details.
- 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. Conflicts with
domain_fqdn,domain_ou,domain_auth_secret_arnand adomain_dns_ips. - domain_
auth_ strsecret_ arn - The ARN for the Secrets Manager secret with the self managed Active Directory credentials for the user joining the domain. Conflicts with
domainanddomain_iam_role_name. - domain_
dns_ Sequence[str]ips - The IPv4 DNS IP addresses of your primary and secondary self managed Active Directory domain controllers. Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list. Conflicts with
domainanddomain_iam_role_name. - domain_
fqdn str - The fully qualified domain name (FQDN) of the self managed Active Directory domain. Conflicts with
domainanddomain_iam_role_name. - domain_
iam_ strrole_ name - The name of the IAM role to be used when making API calls to the Directory Service. Conflicts with
domain_fqdn,domain_ou,domain_auth_secret_arnand adomain_dns_ips. - domain_
ou str - The self managed Active Directory organizational unit for your DB instance to join. Conflicts with
domainanddomain_iam_role_name. - enabled_
cloudwatch_ Sequence[str]logs_ exports - Set of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. For supported values, see the EnableCloudwatchLogsExports.member.N parameter in API action CreateDBInstance.
- 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_upgradeis enabled, you can provide a prefix of the version such as8.0(for8.0.36). 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_snapshotis 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_timeis 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_typeis"io1"or"gp3". Cannot be specified for gp3 storage if theallocated_storagevalue is below a per-enginethreshold. 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 - License model information for this DB instance. Valid values for this field are as follows:
- RDS for MariaDB:
general-public-license - RDS for Microsoft SQL Server:
license-included - RDS for MySQL:
general-public-license - RDS for Oracle:
bring-your-own-license | license-included - RDS for PostgreSQL:
postgresql-license
- RDS for MariaDB:
- 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
passwordis 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_storageor0to 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
- 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_passwordis set to true or unless asnapshot_identifierorreplicate_source_dbis provided ormanage_master_user_passwordis 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_passwordis 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_enabledneeds 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_enabledneeds 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
mountedoropen-read-onlymode. This attribute is only supported by Oracle instances. Oracle replicas operate inopen-read-onlymode 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
identifierof 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
identifierargument 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_idwith a valid ARN. The default isfalseif not specified. - storage_
throughput int - The storage throughput value for the DB instance. Can only be set when
storage_typeis"gp3". Cannot be specified if theallocated_storagevalue is below a per-enginethreshold. 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
iopsindependently) or "io1" (provisioned IOPS SSD). The default is "io1" ifiopsis specified, "gp2" if not. - Mapping[str, str]
- A map of tags to assign to the resource. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - timezone str
- Time zone of the DB instance.
timezoneis currently only supported by Microsoft SQL Server. Thetimezonecan only be set on creation. See MSSQL User Guide for more information. - username str
- (Required unless a
snapshot_identifierorreplicate_source_dbis 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_storageis configured, this argument represents the initial storage allocation and differences from the configuration will be ignored automatically when Storage Autoscaling occurs. Ifreplicate_source_dbis 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
0and35. Default is0. Must be greater than0if 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_updatebelow. - 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.
Cannot be set with
replicate_source_db,restore_to_point_in_time,s3_import, orsnapshot_identifier. - Boolean
- Copy all Instance
tagsto 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_dbattribute 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
defaultVPC, 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 constraints. - dedicated
Log BooleanVolume - Use a dedicated log volume (DLV) for the DB instance. Requires Provisioned IOPS. See the AWS documentation for more details.
- 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. Conflicts with
domain_fqdn,domain_ou,domain_auth_secret_arnand adomain_dns_ips. - domain
Auth StringSecret Arn - The ARN for the Secrets Manager secret with the self managed Active Directory credentials for the user joining the domain. Conflicts with
domainanddomain_iam_role_name. - domain
Dns List<String>Ips - The IPv4 DNS IP addresses of your primary and secondary self managed Active Directory domain controllers. Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list. Conflicts with
domainanddomain_iam_role_name. - domain
Fqdn String - The fully qualified domain name (FQDN) of the self managed Active Directory domain. Conflicts with
domainanddomain_iam_role_name. - domain
Iam StringRole Name - The name of the IAM role to be used when making API calls to the Directory Service. Conflicts with
domain_fqdn,domain_ou,domain_auth_secret_arnand adomain_dns_ips. - domain
Ou String - The self managed Active Directory organizational unit for your DB instance to join. Conflicts with
domainanddomain_iam_role_name. - enabled
Cloudwatch List<String>Logs Exports - Set of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. For supported values, see the EnableCloudwatchLogsExports.member.N parameter in API action CreateDBInstance.
- 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_upgradeis enabled, you can provide a prefix of the version such as8.0(for8.0.36). 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_snapshotis 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_timeis 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_typeis"io1"or"gp3". Cannot be specified for gp3 storage if theallocated_storagevalue is below a per-enginethreshold. 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 - License model information for this DB instance. Valid values for this field are as follows:
- RDS for MariaDB:
general-public-license - RDS for Microsoft SQL Server:
license-included - RDS for MySQL:
general-public-license - RDS for Oracle:
bring-your-own-license | license-included - RDS for PostgreSQL:
postgresql-license
- RDS for MariaDB:
- 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
passwordis 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_storageor0to 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
- 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_passwordis set to true or unless asnapshot_identifierorreplicate_source_dbis provided ormanage_master_user_passwordis 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_passwordis 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_enabledneeds 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_enabledneeds 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
mountedoropen-read-onlymode. This attribute is only supported by Oracle instances. Oracle replicas operate inopen-read-onlymode 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
identifierof 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
identifierargument 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_idwith a valid ARN. The default isfalseif not specified. - storage
Throughput Number - The storage throughput value for the DB instance. Can only be set when
storage_typeis"gp3". Cannot be specified if theallocated_storagevalue is below a per-enginethreshold. 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
iopsindependently) or "io1" (provisioned IOPS SSD). The default is "io1" ifiopsis specified, "gp2" if not. - Map<String>
- A map of tags to assign to the resource. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - timezone String
- Time zone of the DB instance.
timezoneis currently only supported by Microsoft SQL Server. Thetimezonecan only be set on creation. See MSSQL User Guide for more information. - username String
- (Required unless a
snapshot_identifierorreplicate_source_dbis 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:portformat. - 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_passwordis 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_tagsconfiguration block.
- Address string
- Specifies the DNS address of the DB instance.
- Arn string
- The ARN of the RDS instance.
- Endpoint string
- The connection endpoint in
address:portformat. - 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_passwordis 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_tagsconfiguration block.
- address String
- Specifies the DNS address of the DB instance.
- arn String
- The ARN of the RDS instance.
- endpoint String
- The connection endpoint in
address:portformat. - 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_passwordis 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_tagsconfiguration block.
- address string
- Specifies the DNS address of the DB instance.
- arn string
- The ARN of the RDS instance.
- endpoint string
- The connection endpoint in
address:portformat. - 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_passwordis 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_tagsconfiguration block.
- address str
- Specifies the DNS address of the DB instance.
- arn str
- The ARN of the RDS instance.
- endpoint str
- The connection endpoint in
address:portformat. - 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_passwordis 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_tagsconfiguration block.
- address String
- Specifies the DNS address of the DB instance.
- arn String
- The ARN of the RDS instance.
- endpoint String
- The connection endpoint in
address:portformat. - 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_passwordis 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_tagsconfiguration block.
Look up Existing Instance Resource
Get an existing Instance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: InstanceState, opts?: CustomResourceOptions): Instance@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
address: Optional[str] = None,
allocated_storage: Optional[int] = None,
allow_major_version_upgrade: Optional[bool] = None,
apply_immediately: Optional[bool] = None,
arn: Optional[str] = None,
auto_minor_version_upgrade: Optional[bool] = None,
availability_zone: Optional[str] = None,
backup_retention_period: Optional[int] = None,
backup_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,
dedicated_log_volume: Optional[bool] = None,
delete_automated_backups: Optional[bool] = None,
deletion_protection: Optional[bool] = None,
domain: Optional[str] = None,
domain_auth_secret_arn: Optional[str] = None,
domain_dns_ips: Optional[Sequence[str]] = None,
domain_fqdn: Optional[str] = None,
domain_iam_role_name: Optional[str] = None,
domain_ou: 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) -> Instancefunc 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_storageis configured, this argument represents the initial storage allocation and differences from the configuration will be ignored automatically when Storage Autoscaling occurs. Ifreplicate_source_dbis 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
0and35. Default is0. Must be greater than0if 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_updatebelow. - 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.
Cannot be set with
replicate_source_db,restore_to_point_in_time,s3_import, orsnapshot_identifier. - bool
- Copy all Instance
tagsto 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_dbattribute 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
defaultVPC, 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 constraints. - Dedicated
Log boolVolume - Use a dedicated log volume (DLV) for the DB instance. Requires Provisioned IOPS. See the AWS documentation for more details.
- 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. Conflicts with
domain_fqdn,domain_ou,domain_auth_secret_arnand adomain_dns_ips. - Domain
Auth stringSecret Arn - The ARN for the Secrets Manager secret with the self managed Active Directory credentials for the user joining the domain. Conflicts with
domainanddomain_iam_role_name. - Domain
Dns List<string>Ips - The IPv4 DNS IP addresses of your primary and secondary self managed Active Directory domain controllers. Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list. Conflicts with
domainanddomain_iam_role_name. - Domain
Fqdn string - The fully qualified domain name (FQDN) of the self managed Active Directory domain. Conflicts with
domainanddomain_iam_role_name. - Domain
Iam stringRole Name - The name of the IAM role to be used when making API calls to the Directory Service. Conflicts with
domain_fqdn,domain_ou,domain_auth_secret_arnand adomain_dns_ips. - Domain
Ou string - The self managed Active Directory organizational unit for your DB instance to join. Conflicts with
domainanddomain_iam_role_name. - Enabled
Cloudwatch List<string>Logs Exports - Set of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. For supported values, see the EnableCloudwatchLogsExports.member.N parameter in API action CreateDBInstance.
- Endpoint string
- The connection endpoint in
address:portformat. - 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_upgradeis enabled, you can provide a prefix of the version such as8.0(for8.0.36). 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_snapshotis 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_timeis 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_typeis"io1"or"gp3". Cannot be specified for gp3 storage if theallocated_storagevalue is below a per-enginethreshold. 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 - License model information for this DB instance. Valid values for this field are as follows:
- RDS for MariaDB:
general-public-license - RDS for Microsoft SQL Server:
license-included - RDS for MySQL:
general-public-license - RDS for Oracle:
bring-your-own-license | license-included - RDS for PostgreSQL:
postgresql-license
- RDS for MariaDB:
- 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
passwordis 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_passwordis 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_storageor0to 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
- 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_passwordis set to true or unless asnapshot_identifierorreplicate_source_dbis provided ormanage_master_user_passwordis 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_passwordis 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_enabledneeds 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_enabledneeds 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
mountedoropen-read-onlymode. This attribute is only supported by Oracle instances. Oracle replicas operate inopen-read-onlymode 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
identifierof 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
identifierargument 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_idwith a valid ARN. The default isfalseif not specified. - Storage
Throughput int - The storage throughput value for the DB instance. Can only be set when
storage_typeis"gp3". Cannot be specified if theallocated_storagevalue is below a per-enginethreshold. 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
iopsindependently) or "io1" (provisioned IOPS SSD). The default is "io1" ifiopsis specified, "gp2" if not. - Dictionary<string, string>
- A map of tags to assign to the resource. If configured with a provider
default_tagsconfiguration 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_tagsconfiguration block. - Timezone string
- Time zone of the DB instance.
timezoneis currently only supported by Microsoft SQL Server. Thetimezonecan only be set on creation. See MSSQL User Guide for more information. - Username string
- (Required unless a
snapshot_identifierorreplicate_source_dbis 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_storageis configured, this argument represents the initial storage allocation and differences from the configuration will be ignored automatically when Storage Autoscaling occurs. Ifreplicate_source_dbis 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
0and35. Default is0. Must be greater than0if 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_updatebelow. - 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.
Cannot be set with
replicate_source_db,restore_to_point_in_time,s3_import, orsnapshot_identifier. - bool
- Copy all Instance
tagsto 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_dbattribute 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
defaultVPC, 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 constraints. - Dedicated
Log boolVolume - Use a dedicated log volume (DLV) for the DB instance. Requires Provisioned IOPS. See the AWS documentation for more details.
- 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. Conflicts with
domain_fqdn,domain_ou,domain_auth_secret_arnand adomain_dns_ips. - Domain
Auth stringSecret Arn - The ARN for the Secrets Manager secret with the self managed Active Directory credentials for the user joining the domain. Conflicts with
domainanddomain_iam_role_name. - Domain
Dns []stringIps - The IPv4 DNS IP addresses of your primary and secondary self managed Active Directory domain controllers. Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list. Conflicts with
domainanddomain_iam_role_name. - Domain
Fqdn string - The fully qualified domain name (FQDN) of the self managed Active Directory domain. Conflicts with
domainanddomain_iam_role_name. - Domain
Iam stringRole Name - The name of the IAM role to be used when making API calls to the Directory Service. Conflicts with
domain_fqdn,domain_ou,domain_auth_secret_arnand adomain_dns_ips. - Domain
Ou string - The self managed Active Directory organizational unit for your DB instance to join. Conflicts with
domainanddomain_iam_role_name. - Enabled
Cloudwatch []stringLogs Exports - Set of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. For supported values, see the EnableCloudwatchLogsExports.member.N parameter in API action CreateDBInstance.
- Endpoint string
- The connection endpoint in
address:portformat. - 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_upgradeis enabled, you can provide a prefix of the version such as8.0(for8.0.36). 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_snapshotis 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_timeis 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_typeis"io1"or"gp3". Cannot be specified for gp3 storage if theallocated_storagevalue is below a per-enginethreshold. 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 - License model information for this DB instance. Valid values for this field are as follows:
- RDS for MariaDB:
general-public-license - RDS for Microsoft SQL Server:
license-included - RDS for MySQL:
general-public-license - RDS for Oracle:
bring-your-own-license | license-included - RDS for PostgreSQL:
postgresql-license
- RDS for MariaDB:
- 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
passwordis 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_passwordis 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_storageor0to 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
- 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_passwordis set to true or unless asnapshot_identifierorreplicate_source_dbis provided ormanage_master_user_passwordis 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_passwordis 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_enabledneeds 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_enabledneeds 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
mountedoropen-read-onlymode. This attribute is only supported by Oracle instances. Oracle replicas operate inopen-read-onlymode 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
identifierof 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
identifierargument 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_idwith a valid ARN. The default isfalseif not specified. - Storage
Throughput int - The storage throughput value for the DB instance. Can only be set when
storage_typeis"gp3". Cannot be specified if theallocated_storagevalue is below a per-enginethreshold. 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
iopsindependently) or "io1" (provisioned IOPS SSD). The default is "io1" ifiopsis specified, "gp2" if not. - map[string]string
- A map of tags to assign to the resource. If configured with a provider
default_tagsconfiguration 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_tagsconfiguration block. - Timezone string
- Time zone of the DB instance.
timezoneis currently only supported by Microsoft SQL Server. Thetimezonecan only be set on creation. See MSSQL User Guide for more information. - Username string
- (Required unless a
snapshot_identifierorreplicate_source_dbis 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_storageis configured, this argument represents the initial storage allocation and differences from the configuration will be ignored automatically when Storage Autoscaling occurs. Ifreplicate_source_dbis 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
0and35. Default is0. Must be greater than0if 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_updatebelow. - 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.
Cannot be set with
replicate_source_db,restore_to_point_in_time,s3_import, orsnapshot_identifier. - Boolean
- Copy all Instance
tagsto 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_dbattribute 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
defaultVPC, 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 constraints. - dedicated
Log BooleanVolume - Use a dedicated log volume (DLV) for the DB instance. Requires Provisioned IOPS. See the AWS documentation for more details.
- 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. Conflicts with
domain_fqdn,domain_ou,domain_auth_secret_arnand adomain_dns_ips. - domain
Auth StringSecret Arn - The ARN for the Secrets Manager secret with the self managed Active Directory credentials for the user joining the domain. Conflicts with
domainanddomain_iam_role_name. - domain
Dns List<String>Ips - The IPv4 DNS IP addresses of your primary and secondary self managed Active Directory domain controllers. Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list. Conflicts with
domainanddomain_iam_role_name. - domain
Fqdn String - The fully qualified domain name (FQDN) of the self managed Active Directory domain. Conflicts with
domainanddomain_iam_role_name. - domain
Iam StringRole Name - The name of the IAM role to be used when making API calls to the Directory Service. Conflicts with
domain_fqdn,domain_ou,domain_auth_secret_arnand adomain_dns_ips. - domain
Ou String - The self managed Active Directory organizational unit for your DB instance to join. Conflicts with
domainanddomain_iam_role_name. - enabled
Cloudwatch List<String>Logs Exports - Set of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. For supported values, see the EnableCloudwatchLogsExports.member.N parameter in API action CreateDBInstance.
- endpoint String
- The connection endpoint in
address:portformat. - 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_upgradeis enabled, you can provide a prefix of the version such as8.0(for8.0.36). 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_snapshotis 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_timeis 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_typeis"io1"or"gp3". Cannot be specified for gp3 storage if theallocated_storagevalue is below a per-enginethreshold. 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 - License model information for this DB instance. Valid values for this field are as follows:
- RDS for MariaDB:
general-public-license - RDS for Microsoft SQL Server:
license-included - RDS for MySQL:
general-public-license - RDS for Oracle:
bring-your-own-license | license-included - RDS for PostgreSQL:
postgresql-license
- RDS for MariaDB:
- 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
passwordis 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_passwordis 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_storageor0to 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
- 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_passwordis set to true or unless asnapshot_identifierorreplicate_source_dbis provided ormanage_master_user_passwordis 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_passwordis 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_enabledneeds 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_enabledneeds 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
mountedoropen-read-onlymode. This attribute is only supported by Oracle instances. Oracle replicas operate inopen-read-onlymode 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
identifierof 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
identifierargument 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_idwith a valid ARN. The default isfalseif not specified. - storage
Throughput Integer - The storage throughput value for the DB instance. Can only be set when
storage_typeis"gp3". Cannot be specified if theallocated_storagevalue is below a per-enginethreshold. 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
iopsindependently) or "io1" (provisioned IOPS SSD). The default is "io1" ifiopsis specified, "gp2" if not. - Map<String,String>
- A map of tags to assign to the resource. If configured with a provider
default_tagsconfiguration 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_tagsconfiguration block. - timezone String
- Time zone of the DB instance.
timezoneis currently only supported by Microsoft SQL Server. Thetimezonecan only be set on creation. See MSSQL User Guide for more information. - username String
- (Required unless a
snapshot_identifierorreplicate_source_dbis 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_storageis configured, this argument represents the initial storage allocation and differences from the configuration will be ignored automatically when Storage Autoscaling occurs. Ifreplicate_source_dbis 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
0and35. Default is0. Must be greater than0if 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_updatebelow. - 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.
Cannot be set with
replicate_source_db,restore_to_point_in_time,s3_import, orsnapshot_identifier. - boolean
- Copy all Instance
tagsto 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_dbattribute 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
defaultVPC, 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 constraints. - dedicated
Log booleanVolume - Use a dedicated log volume (DLV) for the DB instance. Requires Provisioned IOPS. See the AWS documentation for more details.
- 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. Conflicts with
domain_fqdn,domain_ou,domain_auth_secret_arnand adomain_dns_ips. - domain
Auth stringSecret Arn - The ARN for the Secrets Manager secret with the self managed Active Directory credentials for the user joining the domain. Conflicts with
domainanddomain_iam_role_name. - domain
Dns string[]Ips - The IPv4 DNS IP addresses of your primary and secondary self managed Active Directory domain controllers. Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list. Conflicts with
domainanddomain_iam_role_name. - domain
Fqdn string - The fully qualified domain name (FQDN) of the self managed Active Directory domain. Conflicts with
domainanddomain_iam_role_name. - domain
Iam stringRole Name - The name of the IAM role to be used when making API calls to the Directory Service. Conflicts with
domain_fqdn,domain_ou,domain_auth_secret_arnand adomain_dns_ips. - domain
Ou string - The self managed Active Directory organizational unit for your DB instance to join. Conflicts with
domainanddomain_iam_role_name. - enabled
Cloudwatch string[]Logs Exports - Set of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. For supported values, see the EnableCloudwatchLogsExports.member.N parameter in API action CreateDBInstance.
- endpoint string
- The connection endpoint in
address:portformat. - 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_upgradeis enabled, you can provide a prefix of the version such as8.0(for8.0.36). 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_snapshotis 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_timeis 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_typeis"io1"or"gp3". Cannot be specified for gp3 storage if theallocated_storagevalue is below a per-enginethreshold. 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 - License model information for this DB instance. Valid values for this field are as follows:
- RDS for MariaDB:
general-public-license - RDS for Microsoft SQL Server:
license-included - RDS for MySQL:
general-public-license - RDS for Oracle:
bring-your-own-license | license-included - RDS for PostgreSQL:
postgresql-license
- RDS for MariaDB:
- 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
passwordis 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_passwordis 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_storageor0to 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
- 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_passwordis set to true or unless asnapshot_identifierorreplicate_source_dbis provided ormanage_master_user_passwordis 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_passwordis 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_enabledneeds 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_enabledneeds 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
mountedoropen-read-onlymode. This attribute is only supported by Oracle instances. Oracle replicas operate inopen-read-onlymode 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
identifierof 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
identifierargument 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_idwith a valid ARN. The default isfalseif not specified. - storage
Throughput number - The storage throughput value for the DB instance. Can only be set when
storage_typeis"gp3". Cannot be specified if theallocated_storagevalue is below a per-enginethreshold. 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
iopsindependently) or "io1" (provisioned IOPS SSD). The default is "io1" ifiopsis specified, "gp2" if not. - {[key: string]: string}
- A map of tags to assign to the resource. If configured with a provider
default_tagsconfiguration 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_tagsconfiguration block. - timezone string
- Time zone of the DB instance.
timezoneis currently only supported by Microsoft SQL Server. Thetimezonecan only be set on creation. See MSSQL User Guide for more information. - username string
- (Required unless a
snapshot_identifierorreplicate_source_dbis 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_storageis configured, this argument represents the initial storage allocation and differences from the configuration will be ignored automatically when Storage Autoscaling occurs. Ifreplicate_source_dbis 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
0and35. Default is0. Must be greater than0if 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_updatebelow. - 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.
Cannot be set with
replicate_source_db,restore_to_point_in_time,s3_import, orsnapshot_identifier. - bool
- Copy all Instance
tagsto 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_dbattribute 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
defaultVPC, 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 constraints. - dedicated_
log_ boolvolume - Use a dedicated log volume (DLV) for the DB instance. Requires Provisioned IOPS. See the AWS documentation for more details.
- 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. Conflicts with
domain_fqdn,domain_ou,domain_auth_secret_arnand adomain_dns_ips. - domain_
auth_ strsecret_ arn - The ARN for the Secrets Manager secret with the self managed Active Directory credentials for the user joining the domain. Conflicts with
domainanddomain_iam_role_name. - domain_
dns_ Sequence[str]ips - The IPv4 DNS IP addresses of your primary and secondary self managed Active Directory domain controllers. Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list. Conflicts with
domainanddomain_iam_role_name. - domain_
fqdn str - The fully qualified domain name (FQDN) of the self managed Active Directory domain. Conflicts with
domainanddomain_iam_role_name. - domain_
iam_ strrole_ name - The name of the IAM role to be used when making API calls to the Directory Service. Conflicts with
domain_fqdn,domain_ou,domain_auth_secret_arnand adomain_dns_ips. - domain_
ou str - The self managed Active Directory organizational unit for your DB instance to join. Conflicts with
domainanddomain_iam_role_name. - enabled_
cloudwatch_ Sequence[str]logs_ exports - Set of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. For supported values, see the EnableCloudwatchLogsExports.member.N parameter in API action CreateDBInstance.
- endpoint str
- The connection endpoint in
address:portformat. - 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_upgradeis enabled, you can provide a prefix of the version such as8.0(for8.0.36). 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_snapshotis 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_timeis 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_typeis"io1"or"gp3". Cannot be specified for gp3 storage if theallocated_storagevalue is below a per-enginethreshold. 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 - License model information for this DB instance. Valid values for this field are as follows:
- RDS for MariaDB:
general-public-license - RDS for Microsoft SQL Server:
license-included - RDS for MySQL:
general-public-license - RDS for Oracle:
bring-your-own-license | license-included - RDS for PostgreSQL:
postgresql-license
- RDS for MariaDB:
- 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
passwordis 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_passwordis 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_storageor0to 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
- 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_passwordis set to true or unless asnapshot_identifierorreplicate_source_dbis provided ormanage_master_user_passwordis 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_passwordis 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_enabledneeds 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_enabledneeds 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
mountedoropen-read-onlymode. This attribute is only supported by Oracle instances. Oracle replicas operate inopen-read-onlymode 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
identifierof 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
identifierargument 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_idwith a valid ARN. The default isfalseif not specified. - storage_
throughput int - The storage throughput value for the DB instance. Can only be set when
storage_typeis"gp3". Cannot be specified if theallocated_storagevalue is below a per-enginethreshold. 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
iopsindependently) or "io1" (provisioned IOPS SSD). The default is "io1" ifiopsis specified, "gp2" if not. - Mapping[str, str]
- A map of tags to assign to the resource. If configured with a provider
default_tagsconfiguration 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_tagsconfiguration block. - timezone str
- Time zone of the DB instance.
timezoneis currently only supported by Microsoft SQL Server. Thetimezonecan only be set on creation. See MSSQL User Guide for more information. - username str
- (Required unless a
snapshot_identifierorreplicate_source_dbis 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_storageis configured, this argument represents the initial storage allocation and differences from the configuration will be ignored automatically when Storage Autoscaling occurs. Ifreplicate_source_dbis 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
0and35. Default is0. Must be greater than0if 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_updatebelow. - 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.
Cannot be set with
replicate_source_db,restore_to_point_in_time,s3_import, orsnapshot_identifier. - Boolean
- Copy all Instance
tagsto 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_dbattribute 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
defaultVPC, 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 constraints. - dedicated
Log BooleanVolume - Use a dedicated log volume (DLV) for the DB instance. Requires Provisioned IOPS. See the AWS documentation for more details.
- 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. Conflicts with
domain_fqdn,domain_ou,domain_auth_secret_arnand adomain_dns_ips. - domain
Auth StringSecret Arn - The ARN for the Secrets Manager secret with the self managed Active Directory credentials for the user joining the domain. Conflicts with
domainanddomain_iam_role_name. - domain
Dns List<String>Ips - The IPv4 DNS IP addresses of your primary and secondary self managed Active Directory domain controllers. Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list. Conflicts with
domainanddomain_iam_role_name. - domain
Fqdn String - The fully qualified domain name (FQDN) of the self managed Active Directory domain. Conflicts with
domainanddomain_iam_role_name. - domain
Iam StringRole Name - The name of the IAM role to be used when making API calls to the Directory Service. Conflicts with
domain_fqdn,domain_ou,domain_auth_secret_arnand adomain_dns_ips. - domain
Ou String - The self managed Active Directory organizational unit for your DB instance to join. Conflicts with
domainanddomain_iam_role_name. - enabled
Cloudwatch List<String>Logs Exports - Set of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. For supported values, see the EnableCloudwatchLogsExports.member.N parameter in API action CreateDBInstance.
- endpoint String
- The connection endpoint in
address:portformat. - 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_upgradeis enabled, you can provide a prefix of the version such as8.0(for8.0.36). 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_snapshotis 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_timeis 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_typeis"io1"or"gp3". Cannot be specified for gp3 storage if theallocated_storagevalue is below a per-enginethreshold. 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 - License model information for this DB instance. Valid values for this field are as follows:
- RDS for MariaDB:
general-public-license - RDS for Microsoft SQL Server:
license-included - RDS for MySQL:
general-public-license - RDS for Oracle:
bring-your-own-license | license-included - RDS for PostgreSQL:
postgresql-license
- RDS for MariaDB:
- 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
passwordis 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_passwordis 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_storageor0to 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
- 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_passwordis set to true or unless asnapshot_identifierorreplicate_source_dbis provided ormanage_master_user_passwordis 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_passwordis 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_enabledneeds 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_enabledneeds 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
mountedoropen-read-onlymode. This attribute is only supported by Oracle instances. Oracle replicas operate inopen-read-onlymode 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
identifierof 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
identifierargument 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_idwith a valid ARN. The default isfalseif not specified. - storage
Throughput Number - The storage throughput value for the DB instance. Can only be set when
storage_typeis"gp3". Cannot be specified if theallocated_storagevalue is below a per-enginethreshold. 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
iopsindependently) or "io1" (provisioned IOPS SSD). The default is "io1" ifiopsis specified, "gp2" if not. - Map<String>
- A map of tags to assign to the resource. If configured with a provider
default_tagsconfiguration 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_tagsconfiguration block. - timezone String
- Time zone of the DB instance.
timezoneis currently only supported by Microsoft SQL Server. Thetimezonecan only be set on creation. See MSSQL User Guide for more information. - username String
- (Required unless a
snapshot_identifierorreplicate_source_dbis 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_identifierorsource_dbi_resource_idis 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_arnorsource_dbi_resource_idis not specified. - Source
Dbi stringResource Id - The resource ID of the source DB instance from which to restore. Required if
source_db_instance_identifierorsource_db_instance_automated_backups_arnis 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_identifierorsource_dbi_resource_idis 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_arnorsource_dbi_resource_idis not specified. - Source
Dbi stringResource Id - The resource ID of the source DB instance from which to restore. Required if
source_db_instance_identifierorsource_db_instance_automated_backups_arnis 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_identifierorsource_dbi_resource_idis 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_arnorsource_dbi_resource_idis not specified. - source
Dbi StringResource Id - The resource ID of the source DB instance from which to restore. Required if
source_db_instance_identifierorsource_db_instance_automated_backups_arnis 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_identifierorsource_dbi_resource_idis 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_arnorsource_dbi_resource_idis not specified. - source
Dbi stringResource Id - The resource ID of the source DB instance from which to restore. Required if
source_db_instance_identifierorsource_db_instance_automated_backups_arnis 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_identifierorsource_dbi_resource_idis 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_arnorsource_dbi_resource_idis not specified. - source_
dbi_ strresource_ id - The resource ID of the source DB instance from which to restore. Required if
source_db_instance_identifierorsource_db_instance_automated_backups_arnis 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_identifierorsource_dbi_resource_idis 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_arnorsource_dbi_resource_idis not specified. - source
Dbi StringResource Id - The resource ID of the source DB instance from which to restore. Required if
source_db_instance_identifierorsource_db_instance_automated_backups_arnis 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 - Ingestion
Role string - Source
Engine string - Source
Engine stringVersion - Bucket
Prefix string
- Bucket
Name string - Ingestion
Role string - Source
Engine string - Source
Engine stringVersion - Bucket
Prefix string
- bucket
Name String - ingestion
Role String - source
Engine String - source
Engine StringVersion - bucket
Prefix String
- bucket
Name string - ingestion
Role string - source
Engine string - source
Engine stringVersion - bucket
Prefix string
- bucket_
name str - ingestion_
role str - source_
engine str - source_
engine_ strversion - bucket_
prefix str
- bucket
Name String - ingestion
Role String - source
Engine String - source
Engine StringVersion - bucket
Prefix String
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
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
awsTerraform Provider.
Try AWS Native preview for resources not in the classic version.
AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi