azure-native.awsconnector.RdsDbInstance
Explore with Pulumi AI
A Microsoft.AwsConnector resource Azure REST API version: 2024-12-01.
Example Usage
RdsDbInstances_CreateOrReplace
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var rdsDbInstance = new AzureNative.AwsConnector.RdsDbInstance("rdsDbInstance", new()
{
Location = "pktn",
Name = "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])",
Properties = new AzureNative.AwsConnector.Inputs.RdsDBInstancePropertiesArgs
{
Arn = "ikxozbmzhxy",
AwsAccountId = "xjspz",
AwsProperties = new AzureNative.AwsConnector.Inputs.AwsRdsDBInstancePropertiesArgs
{
AllocatedStorage = "ryhixfujuvwifznymxbze",
AllowMajorVersionUpgrade = true,
AssociatedRoles = new[]
{
new AzureNative.AwsConnector.Inputs.DBInstanceRoleArgs
{
FeatureName = "jyivqbpnmvg",
RoleArn = "jblmzpmkcvnkvsxkswtmfqlwttf",
},
},
AutoMinorVersionUpgrade = true,
AutomaticBackupReplicationKmsKeyId = "eqwqyzovzxcmragbjhqq",
AutomaticBackupReplicationRegion = "h",
AvailabilityZone = "ccdhbiqvvdxbszpuhcvsvpuqfrkosf",
BackupRetentionPeriod = 6,
CaCertificateIdentifier = "dp",
CertificateDetails = new AzureNative.AwsConnector.Inputs.CertificateDetailsArgs
{
CaIdentifier = "jathtqegixcwxcwmnrlrsycxvyp",
ValidTill = "nclrurexsnhed",
},
CertificateRotationRestart = true,
CharacterSetName = "bapraruogdpspvewmd",
CopyTagsToSnapshot = true,
CustomIAMInstanceProfile = "ronoghiguflpqdlwef",
DbClusterIdentifier = "mi",
DbClusterSnapshotIdentifier = "biqdaekgjeyopntgrx",
DbInstanceArn = "xxk",
DbInstanceClass = "xvgbsmhvq",
DbInstanceIdentifier = "svbefulaqhcsf",
DbName = "yryxlwvdmghqcfdlhdyykzejtyep",
DbParameterGroupName = "keuvtxklarpjmikkuwqqfanv",
DbSecurityGroups = new[]
{
"mgcichzarguqhevlwubzgbvs",
},
DbSnapshotIdentifier = "coykeofgbcwpjeihmmajttm",
DbSubnetGroupName = "yxd",
DbSystemId = "rlbhsqhwmezvevqsme",
DbiResourceId = "nlqlrrljz",
DedicatedLogVolume = true,
DeleteAutomatedBackups = true,
DeletionProtection = true,
Domain = "mkboglzqbejwwfplkhpiwsvndwphik",
DomainAuthSecretArn = "dmjcucptjkvsolzcwxwhv",
DomainDnsIps = new[]
{
"celohfbruu",
},
DomainFqdn = "txgpdsxlpqbasbbmpzzkdztlfphm",
DomainIAMRoleName = "ljnyfnuzyqodzawuu",
DomainOu = "yhtbsdxktvxrtweyoo",
EnableCloudwatchLogsExports = new[]
{
"anqxngk",
},
EnableIAMDatabaseAuthentication = true,
EnablePerformanceInsights = true,
Endpoint = new AzureNative.AwsConnector.Inputs.RdsDbInstanceEndpointArgs
{
Address = "rmsxn",
HostedZoneId = "mvsioevf",
Port = "gfpslsfdtnmrahrfppdwaf",
},
Engine = "jztlgxuyyhlwrjkgree",
EngineVersion = "fwmhfzboltipjkflr",
Iops = 6,
KmsKeyId = "pbdblzy",
LicenseModel = "qcmsltdkpdsznfotmqdvnntnfor",
ManageMasterUserPassword = true,
MasterUserPassword = "strxifasjrrb",
MasterUserSecret = new AzureNative.AwsConnector.Inputs.MasterUserSecretArgs
{
KmsKeyId = "czgkafaksjqklj",
SecretArn = "nxpshhiulxttzwuifbqnamexd",
},
MasterUsername = "lfitzeghwpzjhcbje",
MaxAllocatedStorage = 9,
MonitoringInterval = 17,
MonitoringRoleArn = "a",
MultiAZ = true,
NcharCharacterSetName = "cc",
NetworkType = "bccgoqncxrhuwvgwvwta",
OptionGroupName = "mftqhqogtwleqvlpjpbabps",
PerformanceInsightsKMSKeyId = "jyhbotj",
PerformanceInsightsRetentionPeriod = 27,
Port = "g",
PreferredBackupWindow = "wesxjihubbcfgwqebebkzmmfoipd",
PreferredMaintenanceWindow = "gtmzlucaagottcm",
ProcessorFeatures = new[]
{
new AzureNative.AwsConnector.Inputs.ProcessorFeatureArgs
{
Name = AzureNative.AwsConnector.ProcessorFeatureName.CoreCount,
Value = "qhhoewgkcuvttcihy",
},
},
PromotionTier = 12,
PubliclyAccessible = true,
ReplicaMode = "poucyygmqhpztshwupms",
RestoreTime = "nokteyfkzzvhgjtpmiwxajseiavtbk",
SourceDBClusterIdentifier = "gkdeeipcvhmgoabz",
SourceDBInstanceAutomatedBackupsArn = "lisujvucnvopgkehpacmkjshk",
SourceDBInstanceIdentifier = "ypufdzwdqxkygzmrp",
SourceDbiResourceId = "btzodcuervx",
SourceRegion = "ez",
StorageEncrypted = true,
StorageThroughput = 16,
StorageType = "ywcy",
Tags = new[]
{
new AzureNative.AwsConnector.Inputs.TagArgs
{
Key = "kilbegh",
Value = "rdhflka",
},
},
TdeCredentialArn = "twmu",
TdeCredentialPassword = "fqedsuqphkwhafmptzeruepeqalyty",
Timezone = "euyueykvptytmbnfj",
UseDefaultProcessorFeatures = true,
UseLatestRestorableTime = true,
VpcSecurityGroups = new[]
{
"nxllphmorxutzaym",
},
},
AwsRegion = "dmudtaomgrfchc",
AwsSourceSchema = "cjfztsurj",
AwsTags =
{
{ "key3142", "myscjjenjqhbmtoiyyjauxlu" },
},
PublicCloudConnectorsResourceId = "etsvehjovtdbgzuwnmgw",
PublicCloudResourceName = "bvkzujojjsvihxyajddbqxygffaqm",
},
ResourceGroupName = "rgrdsDBInstance",
Tags =
{
{ "key7306", "yhvoznqrgbna" },
},
});
});
package main
import (
awsconnector "github.com/pulumi/pulumi-azure-native-sdk/awsconnector/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := awsconnector.NewRdsDbInstance(ctx, "rdsDbInstance", &awsconnector.RdsDbInstanceArgs{
Location: pulumi.String("pktn"),
Name: pulumi.String("Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])"),
Properties: &awsconnector.RdsDBInstancePropertiesArgs{
Arn: pulumi.String("ikxozbmzhxy"),
AwsAccountId: pulumi.String("xjspz"),
AwsProperties: &awsconnector.AwsRdsDBInstancePropertiesArgs{
AllocatedStorage: pulumi.String("ryhixfujuvwifznymxbze"),
AllowMajorVersionUpgrade: pulumi.Bool(true),
AssociatedRoles: awsconnector.DBInstanceRoleArray{
&awsconnector.DBInstanceRoleArgs{
FeatureName: pulumi.String("jyivqbpnmvg"),
RoleArn: pulumi.String("jblmzpmkcvnkvsxkswtmfqlwttf"),
},
},
AutoMinorVersionUpgrade: pulumi.Bool(true),
AutomaticBackupReplicationKmsKeyId: pulumi.String("eqwqyzovzxcmragbjhqq"),
AutomaticBackupReplicationRegion: pulumi.String("h"),
AvailabilityZone: pulumi.String("ccdhbiqvvdxbszpuhcvsvpuqfrkosf"),
BackupRetentionPeriod: pulumi.Int(6),
CaCertificateIdentifier: pulumi.String("dp"),
CertificateDetails: &awsconnector.CertificateDetailsArgs{
CaIdentifier: pulumi.String("jathtqegixcwxcwmnrlrsycxvyp"),
ValidTill: pulumi.String("nclrurexsnhed"),
},
CertificateRotationRestart: pulumi.Bool(true),
CharacterSetName: pulumi.String("bapraruogdpspvewmd"),
CopyTagsToSnapshot: pulumi.Bool(true),
CustomIAMInstanceProfile: pulumi.String("ronoghiguflpqdlwef"),
DbClusterIdentifier: pulumi.String("mi"),
DbClusterSnapshotIdentifier: pulumi.String("biqdaekgjeyopntgrx"),
DbInstanceArn: pulumi.String("xxk"),
DbInstanceClass: pulumi.String("xvgbsmhvq"),
DbInstanceIdentifier: pulumi.String("svbefulaqhcsf"),
DbName: pulumi.String("yryxlwvdmghqcfdlhdyykzejtyep"),
DbParameterGroupName: pulumi.String("keuvtxklarpjmikkuwqqfanv"),
DbSecurityGroups: pulumi.StringArray{
pulumi.String("mgcichzarguqhevlwubzgbvs"),
},
DbSnapshotIdentifier: pulumi.String("coykeofgbcwpjeihmmajttm"),
DbSubnetGroupName: pulumi.String("yxd"),
DbSystemId: pulumi.String("rlbhsqhwmezvevqsme"),
DbiResourceId: pulumi.String("nlqlrrljz"),
DedicatedLogVolume: pulumi.Bool(true),
DeleteAutomatedBackups: pulumi.Bool(true),
DeletionProtection: pulumi.Bool(true),
Domain: pulumi.String("mkboglzqbejwwfplkhpiwsvndwphik"),
DomainAuthSecretArn: pulumi.String("dmjcucptjkvsolzcwxwhv"),
DomainDnsIps: pulumi.StringArray{
pulumi.String("celohfbruu"),
},
DomainFqdn: pulumi.String("txgpdsxlpqbasbbmpzzkdztlfphm"),
DomainIAMRoleName: pulumi.String("ljnyfnuzyqodzawuu"),
DomainOu: pulumi.String("yhtbsdxktvxrtweyoo"),
EnableCloudwatchLogsExports: pulumi.StringArray{
pulumi.String("anqxngk"),
},
EnableIAMDatabaseAuthentication: pulumi.Bool(true),
EnablePerformanceInsights: pulumi.Bool(true),
Endpoint: &awsconnector.RdsDbInstanceEndpointArgs{
Address: pulumi.String("rmsxn"),
HostedZoneId: pulumi.String("mvsioevf"),
Port: pulumi.String("gfpslsfdtnmrahrfppdwaf"),
},
Engine: pulumi.String("jztlgxuyyhlwrjkgree"),
EngineVersion: pulumi.String("fwmhfzboltipjkflr"),
Iops: pulumi.Int(6),
KmsKeyId: pulumi.String("pbdblzy"),
LicenseModel: pulumi.String("qcmsltdkpdsznfotmqdvnntnfor"),
ManageMasterUserPassword: pulumi.Bool(true),
MasterUserPassword: pulumi.String("strxifasjrrb"),
MasterUserSecret: &awsconnector.MasterUserSecretArgs{
KmsKeyId: pulumi.String("czgkafaksjqklj"),
SecretArn: pulumi.String("nxpshhiulxttzwuifbqnamexd"),
},
MasterUsername: pulumi.String("lfitzeghwpzjhcbje"),
MaxAllocatedStorage: pulumi.Int(9),
MonitoringInterval: pulumi.Int(17),
MonitoringRoleArn: pulumi.String("a"),
MultiAZ: pulumi.Bool(true),
NcharCharacterSetName: pulumi.String("cc"),
NetworkType: pulumi.String("bccgoqncxrhuwvgwvwta"),
OptionGroupName: pulumi.String("mftqhqogtwleqvlpjpbabps"),
PerformanceInsightsKMSKeyId: pulumi.String("jyhbotj"),
PerformanceInsightsRetentionPeriod: pulumi.Int(27),
Port: pulumi.String("g"),
PreferredBackupWindow: pulumi.String("wesxjihubbcfgwqebebkzmmfoipd"),
PreferredMaintenanceWindow: pulumi.String("gtmzlucaagottcm"),
ProcessorFeatures: awsconnector.ProcessorFeatureArray{
&awsconnector.ProcessorFeatureArgs{
Name: pulumi.String(awsconnector.ProcessorFeatureNameCoreCount),
Value: pulumi.String("qhhoewgkcuvttcihy"),
},
},
PromotionTier: pulumi.Int(12),
PubliclyAccessible: pulumi.Bool(true),
ReplicaMode: pulumi.String("poucyygmqhpztshwupms"),
RestoreTime: pulumi.String("nokteyfkzzvhgjtpmiwxajseiavtbk"),
SourceDBClusterIdentifier: pulumi.String("gkdeeipcvhmgoabz"),
SourceDBInstanceAutomatedBackupsArn: pulumi.String("lisujvucnvopgkehpacmkjshk"),
SourceDBInstanceIdentifier: pulumi.String("ypufdzwdqxkygzmrp"),
SourceDbiResourceId: pulumi.String("btzodcuervx"),
SourceRegion: pulumi.String("ez"),
StorageEncrypted: pulumi.Bool(true),
StorageThroughput: pulumi.Int(16),
StorageType: pulumi.String("ywcy"),
Tags: awsconnector.TagArray{
&awsconnector.TagArgs{
Key: pulumi.String("kilbegh"),
Value: pulumi.String("rdhflka"),
},
},
TdeCredentialArn: pulumi.String("twmu"),
TdeCredentialPassword: pulumi.String("fqedsuqphkwhafmptzeruepeqalyty"),
Timezone: pulumi.String("euyueykvptytmbnfj"),
UseDefaultProcessorFeatures: pulumi.Bool(true),
UseLatestRestorableTime: pulumi.Bool(true),
VpcSecurityGroups: pulumi.StringArray{
pulumi.String("nxllphmorxutzaym"),
},
},
AwsRegion: pulumi.String("dmudtaomgrfchc"),
AwsSourceSchema: pulumi.String("cjfztsurj"),
AwsTags: pulumi.StringMap{
"key3142": pulumi.String("myscjjenjqhbmtoiyyjauxlu"),
},
PublicCloudConnectorsResourceId: pulumi.String("etsvehjovtdbgzuwnmgw"),
PublicCloudResourceName: pulumi.String("bvkzujojjsvihxyajddbqxygffaqm"),
},
ResourceGroupName: pulumi.String("rgrdsDBInstance"),
Tags: pulumi.StringMap{
"key7306": pulumi.String("yhvoznqrgbna"),
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.awsconnector.RdsDbInstance;
import com.pulumi.azurenative.awsconnector.RdsDbInstanceArgs;
import com.pulumi.azurenative.awsconnector.inputs.RdsDBInstancePropertiesArgs;
import com.pulumi.azurenative.awsconnector.inputs.AwsRdsDBInstancePropertiesArgs;
import com.pulumi.azurenative.awsconnector.inputs.CertificateDetailsArgs;
import com.pulumi.azurenative.awsconnector.inputs.RdsDbInstanceEndpointArgs;
import com.pulumi.azurenative.awsconnector.inputs.MasterUserSecretArgs;
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 rdsDbInstance = new RdsDbInstance("rdsDbInstance", RdsDbInstanceArgs.builder()
.location("pktn")
.name("Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])")
.properties(RdsDBInstancePropertiesArgs.builder()
.arn("ikxozbmzhxy")
.awsAccountId("xjspz")
.awsProperties(AwsRdsDBInstancePropertiesArgs.builder()
.allocatedStorage("ryhixfujuvwifznymxbze")
.allowMajorVersionUpgrade(true)
.associatedRoles(DBInstanceRoleArgs.builder()
.featureName("jyivqbpnmvg")
.roleArn("jblmzpmkcvnkvsxkswtmfqlwttf")
.build())
.autoMinorVersionUpgrade(true)
.automaticBackupReplicationKmsKeyId("eqwqyzovzxcmragbjhqq")
.automaticBackupReplicationRegion("h")
.availabilityZone("ccdhbiqvvdxbszpuhcvsvpuqfrkosf")
.backupRetentionPeriod(6)
.caCertificateIdentifier("dp")
.certificateDetails(CertificateDetailsArgs.builder()
.caIdentifier("jathtqegixcwxcwmnrlrsycxvyp")
.validTill("nclrurexsnhed")
.build())
.certificateRotationRestart(true)
.characterSetName("bapraruogdpspvewmd")
.copyTagsToSnapshot(true)
.customIAMInstanceProfile("ronoghiguflpqdlwef")
.dbClusterIdentifier("mi")
.dbClusterSnapshotIdentifier("biqdaekgjeyopntgrx")
.dbInstanceArn("xxk")
.dbInstanceClass("xvgbsmhvq")
.dbInstanceIdentifier("svbefulaqhcsf")
.dbName("yryxlwvdmghqcfdlhdyykzejtyep")
.dbParameterGroupName("keuvtxklarpjmikkuwqqfanv")
.dbSecurityGroups("mgcichzarguqhevlwubzgbvs")
.dbSnapshotIdentifier("coykeofgbcwpjeihmmajttm")
.dbSubnetGroupName("yxd")
.dbSystemId("rlbhsqhwmezvevqsme")
.dbiResourceId("nlqlrrljz")
.dedicatedLogVolume(true)
.deleteAutomatedBackups(true)
.deletionProtection(true)
.domain("mkboglzqbejwwfplkhpiwsvndwphik")
.domainAuthSecretArn("dmjcucptjkvsolzcwxwhv")
.domainDnsIps("celohfbruu")
.domainFqdn("txgpdsxlpqbasbbmpzzkdztlfphm")
.domainIAMRoleName("ljnyfnuzyqodzawuu")
.domainOu("yhtbsdxktvxrtweyoo")
.enableCloudwatchLogsExports("anqxngk")
.enableIAMDatabaseAuthentication(true)
.enablePerformanceInsights(true)
.endpoint(RdsDbInstanceEndpointArgs.builder()
.address("rmsxn")
.hostedZoneId("mvsioevf")
.port("gfpslsfdtnmrahrfppdwaf")
.build())
.engine("jztlgxuyyhlwrjkgree")
.engineVersion("fwmhfzboltipjkflr")
.iops(6)
.kmsKeyId("pbdblzy")
.licenseModel("qcmsltdkpdsznfotmqdvnntnfor")
.manageMasterUserPassword(true)
.masterUserPassword("strxifasjrrb")
.masterUserSecret(MasterUserSecretArgs.builder()
.kmsKeyId("czgkafaksjqklj")
.secretArn("nxpshhiulxttzwuifbqnamexd")
.build())
.masterUsername("lfitzeghwpzjhcbje")
.maxAllocatedStorage(9)
.monitoringInterval(17)
.monitoringRoleArn("a")
.multiAZ(true)
.ncharCharacterSetName("cc")
.networkType("bccgoqncxrhuwvgwvwta")
.optionGroupName("mftqhqogtwleqvlpjpbabps")
.performanceInsightsKMSKeyId("jyhbotj")
.performanceInsightsRetentionPeriod(27)
.port("g")
.preferredBackupWindow("wesxjihubbcfgwqebebkzmmfoipd")
.preferredMaintenanceWindow("gtmzlucaagottcm")
.processorFeatures(ProcessorFeatureArgs.builder()
.name("coreCount")
.value("qhhoewgkcuvttcihy")
.build())
.promotionTier(12)
.publiclyAccessible(true)
.replicaMode("poucyygmqhpztshwupms")
.restoreTime("nokteyfkzzvhgjtpmiwxajseiavtbk")
.sourceDBClusterIdentifier("gkdeeipcvhmgoabz")
.sourceDBInstanceAutomatedBackupsArn("lisujvucnvopgkehpacmkjshk")
.sourceDBInstanceIdentifier("ypufdzwdqxkygzmrp")
.sourceDbiResourceId("btzodcuervx")
.sourceRegion("ez")
.storageEncrypted(true)
.storageThroughput(16)
.storageType("ywcy")
.tags(TagArgs.builder()
.key("kilbegh")
.value("rdhflka")
.build())
.tdeCredentialArn("twmu")
.tdeCredentialPassword("fqedsuqphkwhafmptzeruepeqalyty")
.timezone("euyueykvptytmbnfj")
.useDefaultProcessorFeatures(true)
.useLatestRestorableTime(true)
.vpcSecurityGroups("nxllphmorxutzaym")
.build())
.awsRegion("dmudtaomgrfchc")
.awsSourceSchema("cjfztsurj")
.awsTags(Map.of("key3142", "myscjjenjqhbmtoiyyjauxlu"))
.publicCloudConnectorsResourceId("etsvehjovtdbgzuwnmgw")
.publicCloudResourceName("bvkzujojjsvihxyajddbqxygffaqm")
.build())
.resourceGroupName("rgrdsDBInstance")
.tags(Map.of("key7306", "yhvoznqrgbna"))
.build());
}
}
import pulumi
import pulumi_azure_native as azure_native
rds_db_instance = azure_native.awsconnector.RdsDbInstance("rdsDbInstance",
location="pktn",
name="Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])",
properties={
"arn": "ikxozbmzhxy",
"aws_account_id": "xjspz",
"aws_properties": {
"allocated_storage": "ryhixfujuvwifznymxbze",
"allow_major_version_upgrade": True,
"associated_roles": [{
"feature_name": "jyivqbpnmvg",
"role_arn": "jblmzpmkcvnkvsxkswtmfqlwttf",
}],
"auto_minor_version_upgrade": True,
"automatic_backup_replication_kms_key_id": "eqwqyzovzxcmragbjhqq",
"automatic_backup_replication_region": "h",
"availability_zone": "ccdhbiqvvdxbszpuhcvsvpuqfrkosf",
"backup_retention_period": 6,
"ca_certificate_identifier": "dp",
"certificate_details": {
"ca_identifier": "jathtqegixcwxcwmnrlrsycxvyp",
"valid_till": "nclrurexsnhed",
},
"certificate_rotation_restart": True,
"character_set_name": "bapraruogdpspvewmd",
"copy_tags_to_snapshot": True,
"custom_iam_instance_profile": "ronoghiguflpqdlwef",
"db_cluster_identifier": "mi",
"db_cluster_snapshot_identifier": "biqdaekgjeyopntgrx",
"db_instance_arn": "xxk",
"db_instance_class": "xvgbsmhvq",
"db_instance_identifier": "svbefulaqhcsf",
"db_name": "yryxlwvdmghqcfdlhdyykzejtyep",
"db_parameter_group_name": "keuvtxklarpjmikkuwqqfanv",
"db_security_groups": ["mgcichzarguqhevlwubzgbvs"],
"db_snapshot_identifier": "coykeofgbcwpjeihmmajttm",
"db_subnet_group_name": "yxd",
"db_system_id": "rlbhsqhwmezvevqsme",
"dbi_resource_id": "nlqlrrljz",
"dedicated_log_volume": True,
"delete_automated_backups": True,
"deletion_protection": True,
"domain": "mkboglzqbejwwfplkhpiwsvndwphik",
"domain_auth_secret_arn": "dmjcucptjkvsolzcwxwhv",
"domain_dns_ips": ["celohfbruu"],
"domain_fqdn": "txgpdsxlpqbasbbmpzzkdztlfphm",
"domain_iam_role_name": "ljnyfnuzyqodzawuu",
"domain_ou": "yhtbsdxktvxrtweyoo",
"enable_cloudwatch_logs_exports": ["anqxngk"],
"enable_iam_database_authentication": True,
"enable_performance_insights": True,
"endpoint": {
"address": "rmsxn",
"hosted_zone_id": "mvsioevf",
"port": "gfpslsfdtnmrahrfppdwaf",
},
"engine": "jztlgxuyyhlwrjkgree",
"engine_version": "fwmhfzboltipjkflr",
"iops": 6,
"kms_key_id": "pbdblzy",
"license_model": "qcmsltdkpdsznfotmqdvnntnfor",
"manage_master_user_password": True,
"master_user_password": "strxifasjrrb",
"master_user_secret": {
"kms_key_id": "czgkafaksjqklj",
"secret_arn": "nxpshhiulxttzwuifbqnamexd",
},
"master_username": "lfitzeghwpzjhcbje",
"max_allocated_storage": 9,
"monitoring_interval": 17,
"monitoring_role_arn": "a",
"multi_az": True,
"nchar_character_set_name": "cc",
"network_type": "bccgoqncxrhuwvgwvwta",
"option_group_name": "mftqhqogtwleqvlpjpbabps",
"performance_insights_kms_key_id": "jyhbotj",
"performance_insights_retention_period": 27,
"port": "g",
"preferred_backup_window": "wesxjihubbcfgwqebebkzmmfoipd",
"preferred_maintenance_window": "gtmzlucaagottcm",
"processor_features": [{
"name": azure_native.awsconnector.ProcessorFeatureName.CORE_COUNT,
"value": "qhhoewgkcuvttcihy",
}],
"promotion_tier": 12,
"publicly_accessible": True,
"replica_mode": "poucyygmqhpztshwupms",
"restore_time": "nokteyfkzzvhgjtpmiwxajseiavtbk",
"source_db_cluster_identifier": "gkdeeipcvhmgoabz",
"source_db_instance_automated_backups_arn": "lisujvucnvopgkehpacmkjshk",
"source_db_instance_identifier": "ypufdzwdqxkygzmrp",
"source_dbi_resource_id": "btzodcuervx",
"source_region": "ez",
"storage_encrypted": True,
"storage_throughput": 16,
"storage_type": "ywcy",
"tags": [{
"key": "kilbegh",
"value": "rdhflka",
}],
"tde_credential_arn": "twmu",
"tde_credential_password": "fqedsuqphkwhafmptzeruepeqalyty",
"timezone": "euyueykvptytmbnfj",
"use_default_processor_features": True,
"use_latest_restorable_time": True,
"vpc_security_groups": ["nxllphmorxutzaym"],
},
"aws_region": "dmudtaomgrfchc",
"aws_source_schema": "cjfztsurj",
"aws_tags": {
"key3142": "myscjjenjqhbmtoiyyjauxlu",
},
"public_cloud_connectors_resource_id": "etsvehjovtdbgzuwnmgw",
"public_cloud_resource_name": "bvkzujojjsvihxyajddbqxygffaqm",
},
resource_group_name="rgrdsDBInstance",
tags={
"key7306": "yhvoznqrgbna",
})
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const rdsDbInstance = new azure_native.awsconnector.RdsDbInstance("rdsDbInstance", {
location: "pktn",
name: "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])",
properties: {
arn: "ikxozbmzhxy",
awsAccountId: "xjspz",
awsProperties: {
allocatedStorage: "ryhixfujuvwifznymxbze",
allowMajorVersionUpgrade: true,
associatedRoles: [{
featureName: "jyivqbpnmvg",
roleArn: "jblmzpmkcvnkvsxkswtmfqlwttf",
}],
autoMinorVersionUpgrade: true,
automaticBackupReplicationKmsKeyId: "eqwqyzovzxcmragbjhqq",
automaticBackupReplicationRegion: "h",
availabilityZone: "ccdhbiqvvdxbszpuhcvsvpuqfrkosf",
backupRetentionPeriod: 6,
caCertificateIdentifier: "dp",
certificateDetails: {
caIdentifier: "jathtqegixcwxcwmnrlrsycxvyp",
validTill: "nclrurexsnhed",
},
certificateRotationRestart: true,
characterSetName: "bapraruogdpspvewmd",
copyTagsToSnapshot: true,
customIAMInstanceProfile: "ronoghiguflpqdlwef",
dbClusterIdentifier: "mi",
dbClusterSnapshotIdentifier: "biqdaekgjeyopntgrx",
dbInstanceArn: "xxk",
dbInstanceClass: "xvgbsmhvq",
dbInstanceIdentifier: "svbefulaqhcsf",
dbName: "yryxlwvdmghqcfdlhdyykzejtyep",
dbParameterGroupName: "keuvtxklarpjmikkuwqqfanv",
dbSecurityGroups: ["mgcichzarguqhevlwubzgbvs"],
dbSnapshotIdentifier: "coykeofgbcwpjeihmmajttm",
dbSubnetGroupName: "yxd",
dbSystemId: "rlbhsqhwmezvevqsme",
dbiResourceId: "nlqlrrljz",
dedicatedLogVolume: true,
deleteAutomatedBackups: true,
deletionProtection: true,
domain: "mkboglzqbejwwfplkhpiwsvndwphik",
domainAuthSecretArn: "dmjcucptjkvsolzcwxwhv",
domainDnsIps: ["celohfbruu"],
domainFqdn: "txgpdsxlpqbasbbmpzzkdztlfphm",
domainIAMRoleName: "ljnyfnuzyqodzawuu",
domainOu: "yhtbsdxktvxrtweyoo",
enableCloudwatchLogsExports: ["anqxngk"],
enableIAMDatabaseAuthentication: true,
enablePerformanceInsights: true,
endpoint: {
address: "rmsxn",
hostedZoneId: "mvsioevf",
port: "gfpslsfdtnmrahrfppdwaf",
},
engine: "jztlgxuyyhlwrjkgree",
engineVersion: "fwmhfzboltipjkflr",
iops: 6,
kmsKeyId: "pbdblzy",
licenseModel: "qcmsltdkpdsznfotmqdvnntnfor",
manageMasterUserPassword: true,
masterUserPassword: "strxifasjrrb",
masterUserSecret: {
kmsKeyId: "czgkafaksjqklj",
secretArn: "nxpshhiulxttzwuifbqnamexd",
},
masterUsername: "lfitzeghwpzjhcbje",
maxAllocatedStorage: 9,
monitoringInterval: 17,
monitoringRoleArn: "a",
multiAZ: true,
ncharCharacterSetName: "cc",
networkType: "bccgoqncxrhuwvgwvwta",
optionGroupName: "mftqhqogtwleqvlpjpbabps",
performanceInsightsKMSKeyId: "jyhbotj",
performanceInsightsRetentionPeriod: 27,
port: "g",
preferredBackupWindow: "wesxjihubbcfgwqebebkzmmfoipd",
preferredMaintenanceWindow: "gtmzlucaagottcm",
processorFeatures: [{
name: azure_native.awsconnector.ProcessorFeatureName.CoreCount,
value: "qhhoewgkcuvttcihy",
}],
promotionTier: 12,
publiclyAccessible: true,
replicaMode: "poucyygmqhpztshwupms",
restoreTime: "nokteyfkzzvhgjtpmiwxajseiavtbk",
sourceDBClusterIdentifier: "gkdeeipcvhmgoabz",
sourceDBInstanceAutomatedBackupsArn: "lisujvucnvopgkehpacmkjshk",
sourceDBInstanceIdentifier: "ypufdzwdqxkygzmrp",
sourceDbiResourceId: "btzodcuervx",
sourceRegion: "ez",
storageEncrypted: true,
storageThroughput: 16,
storageType: "ywcy",
tags: [{
key: "kilbegh",
value: "rdhflka",
}],
tdeCredentialArn: "twmu",
tdeCredentialPassword: "fqedsuqphkwhafmptzeruepeqalyty",
timezone: "euyueykvptytmbnfj",
useDefaultProcessorFeatures: true,
useLatestRestorableTime: true,
vpcSecurityGroups: ["nxllphmorxutzaym"],
},
awsRegion: "dmudtaomgrfchc",
awsSourceSchema: "cjfztsurj",
awsTags: {
key3142: "myscjjenjqhbmtoiyyjauxlu",
},
publicCloudConnectorsResourceId: "etsvehjovtdbgzuwnmgw",
publicCloudResourceName: "bvkzujojjsvihxyajddbqxygffaqm",
},
resourceGroupName: "rgrdsDBInstance",
tags: {
key7306: "yhvoznqrgbna",
},
});
resources:
rdsDbInstance:
type: azure-native:awsconnector:RdsDbInstance
properties:
location: pktn
name: Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])
properties:
arn: ikxozbmzhxy
awsAccountId: xjspz
awsProperties:
allocatedStorage: ryhixfujuvwifznymxbze
allowMajorVersionUpgrade: true
associatedRoles:
- featureName: jyivqbpnmvg
roleArn: jblmzpmkcvnkvsxkswtmfqlwttf
autoMinorVersionUpgrade: true
automaticBackupReplicationKmsKeyId: eqwqyzovzxcmragbjhqq
automaticBackupReplicationRegion: h
availabilityZone: ccdhbiqvvdxbszpuhcvsvpuqfrkosf
backupRetentionPeriod: 6
caCertificateIdentifier: dp
certificateDetails:
caIdentifier: jathtqegixcwxcwmnrlrsycxvyp
validTill: nclrurexsnhed
certificateRotationRestart: true
characterSetName: bapraruogdpspvewmd
copyTagsToSnapshot: true
customIAMInstanceProfile: ronoghiguflpqdlwef
dbClusterIdentifier: mi
dbClusterSnapshotIdentifier: biqdaekgjeyopntgrx
dbInstanceArn: xxk
dbInstanceClass: xvgbsmhvq
dbInstanceIdentifier: svbefulaqhcsf
dbName: yryxlwvdmghqcfdlhdyykzejtyep
dbParameterGroupName: keuvtxklarpjmikkuwqqfanv
dbSecurityGroups:
- mgcichzarguqhevlwubzgbvs
dbSnapshotIdentifier: coykeofgbcwpjeihmmajttm
dbSubnetGroupName: yxd
dbSystemId: rlbhsqhwmezvevqsme
dbiResourceId: nlqlrrljz
dedicatedLogVolume: true
deleteAutomatedBackups: true
deletionProtection: true
domain: mkboglzqbejwwfplkhpiwsvndwphik
domainAuthSecretArn: dmjcucptjkvsolzcwxwhv
domainDnsIps:
- celohfbruu
domainFqdn: txgpdsxlpqbasbbmpzzkdztlfphm
domainIAMRoleName: ljnyfnuzyqodzawuu
domainOu: yhtbsdxktvxrtweyoo
enableCloudwatchLogsExports:
- anqxngk
enableIAMDatabaseAuthentication: true
enablePerformanceInsights: true
endpoint:
address: rmsxn
hostedZoneId: mvsioevf
port: gfpslsfdtnmrahrfppdwaf
engine: jztlgxuyyhlwrjkgree
engineVersion: fwmhfzboltipjkflr
iops: 6
kmsKeyId: pbdblzy
licenseModel: qcmsltdkpdsznfotmqdvnntnfor
manageMasterUserPassword: true
masterUserPassword: strxifasjrrb
masterUserSecret:
kmsKeyId: czgkafaksjqklj
secretArn: nxpshhiulxttzwuifbqnamexd
masterUsername: lfitzeghwpzjhcbje
maxAllocatedStorage: 9
monitoringInterval: 17
monitoringRoleArn: a
multiAZ: true
ncharCharacterSetName: cc
networkType: bccgoqncxrhuwvgwvwta
optionGroupName: mftqhqogtwleqvlpjpbabps
performanceInsightsKMSKeyId: jyhbotj
performanceInsightsRetentionPeriod: 27
port: g
preferredBackupWindow: wesxjihubbcfgwqebebkzmmfoipd
preferredMaintenanceWindow: gtmzlucaagottcm
processorFeatures:
- name: coreCount
value: qhhoewgkcuvttcihy
promotionTier: 12
publiclyAccessible: true
replicaMode: poucyygmqhpztshwupms
restoreTime: nokteyfkzzvhgjtpmiwxajseiavtbk
sourceDBClusterIdentifier: gkdeeipcvhmgoabz
sourceDBInstanceAutomatedBackupsArn: lisujvucnvopgkehpacmkjshk
sourceDBInstanceIdentifier: ypufdzwdqxkygzmrp
sourceDbiResourceId: btzodcuervx
sourceRegion: ez
storageEncrypted: true
storageThroughput: 16
storageType: ywcy
tags:
- key: kilbegh
value: rdhflka
tdeCredentialArn: twmu
tdeCredentialPassword: fqedsuqphkwhafmptzeruepeqalyty
timezone: euyueykvptytmbnfj
useDefaultProcessorFeatures: true
useLatestRestorableTime: true
vpcSecurityGroups:
- nxllphmorxutzaym
awsRegion: dmudtaomgrfchc
awsSourceSchema: cjfztsurj
awsTags:
key3142: myscjjenjqhbmtoiyyjauxlu
publicCloudConnectorsResourceId: etsvehjovtdbgzuwnmgw
publicCloudResourceName: bvkzujojjsvihxyajddbqxygffaqm
resourceGroupName: rgrdsDBInstance
tags:
key7306: yhvoznqrgbna
Create RdsDbInstance Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new RdsDbInstance(name: string, args: RdsDbInstanceArgs, opts?: CustomResourceOptions);
@overload
def RdsDbInstance(resource_name: str,
args: RdsDbInstanceArgs,
opts: Optional[ResourceOptions] = None)
@overload
def RdsDbInstance(resource_name: str,
opts: Optional[ResourceOptions] = None,
resource_group_name: Optional[str] = None,
location: Optional[str] = None,
name: Optional[str] = None,
properties: Optional[RdsDBInstancePropertiesArgs] = None,
tags: Optional[Mapping[str, str]] = None)
func NewRdsDbInstance(ctx *Context, name string, args RdsDbInstanceArgs, opts ...ResourceOption) (*RdsDbInstance, error)
public RdsDbInstance(string name, RdsDbInstanceArgs args, CustomResourceOptions? opts = null)
public RdsDbInstance(String name, RdsDbInstanceArgs args)
public RdsDbInstance(String name, RdsDbInstanceArgs args, CustomResourceOptions options)
type: azure-native:awsconnector:RdsDbInstance
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 RdsDbInstanceArgs
- 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 RdsDbInstanceArgs
- 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 RdsDbInstanceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args RdsDbInstanceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args RdsDbInstanceArgs
- 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 rdsDbInstanceResource = new AzureNative.AwsConnector.RdsDbInstance("rdsDbInstanceResource", new()
{
ResourceGroupName = "string",
Location = "string",
Name = "string",
Properties = new AzureNative.AwsConnector.Inputs.RdsDBInstancePropertiesArgs
{
Arn = "string",
AwsAccountId = "string",
AwsProperties = new AzureNative.AwsConnector.Inputs.AwsRdsDBInstancePropertiesArgs
{
AllocatedStorage = "string",
AllowMajorVersionUpgrade = false,
AssociatedRoles = new[]
{
new AzureNative.AwsConnector.Inputs.DBInstanceRoleArgs
{
FeatureName = "string",
RoleArn = "string",
},
},
AutoMinorVersionUpgrade = false,
AutomaticBackupReplicationKmsKeyId = "string",
AutomaticBackupReplicationRegion = "string",
AvailabilityZone = "string",
BackupRetentionPeriod = 0,
CaCertificateIdentifier = "string",
CertificateDetails = new AzureNative.AwsConnector.Inputs.CertificateDetailsArgs
{
CaIdentifier = "string",
ValidTill = "string",
},
CertificateRotationRestart = false,
CharacterSetName = "string",
CopyTagsToSnapshot = false,
CustomIAMInstanceProfile = "string",
DbClusterIdentifier = "string",
DbClusterSnapshotIdentifier = "string",
DbInstanceArn = "string",
DbInstanceClass = "string",
DbInstanceIdentifier = "string",
DbName = "string",
DbParameterGroupName = "string",
DbSecurityGroups = new[]
{
"string",
},
DbSnapshotIdentifier = "string",
DbSubnetGroupName = "string",
DbSystemId = "string",
DbiResourceId = "string",
DedicatedLogVolume = false,
DeleteAutomatedBackups = false,
DeletionProtection = false,
Domain = "string",
DomainAuthSecretArn = "string",
DomainDnsIps = new[]
{
"string",
},
DomainFqdn = "string",
DomainIAMRoleName = "string",
DomainOu = "string",
EnableCloudwatchLogsExports = new[]
{
"string",
},
EnableIAMDatabaseAuthentication = false,
EnablePerformanceInsights = false,
Endpoint = new AzureNative.AwsConnector.Inputs.RdsDbInstanceEndpointArgs
{
Address = "string",
HostedZoneId = "string",
Port = "string",
},
Engine = "string",
EngineVersion = "string",
Iops = 0,
KmsKeyId = "string",
LicenseModel = "string",
ManageMasterUserPassword = false,
MasterUserPassword = "string",
MasterUserSecret = new AzureNative.AwsConnector.Inputs.MasterUserSecretArgs
{
KmsKeyId = "string",
SecretArn = "string",
},
MasterUsername = "string",
MaxAllocatedStorage = 0,
MonitoringInterval = 0,
MonitoringRoleArn = "string",
MultiAZ = false,
NcharCharacterSetName = "string",
NetworkType = "string",
OptionGroupName = "string",
PerformanceInsightsKMSKeyId = "string",
PerformanceInsightsRetentionPeriod = 0,
Port = "string",
PreferredBackupWindow = "string",
PreferredMaintenanceWindow = "string",
ProcessorFeatures = new[]
{
new AzureNative.AwsConnector.Inputs.ProcessorFeatureArgs
{
Name = "string",
Value = "string",
},
},
PromotionTier = 0,
PubliclyAccessible = false,
ReplicaMode = "string",
RestoreTime = "string",
SourceDBClusterIdentifier = "string",
SourceDBInstanceAutomatedBackupsArn = "string",
SourceDBInstanceIdentifier = "string",
SourceDbiResourceId = "string",
SourceRegion = "string",
StorageEncrypted = false,
StorageThroughput = 0,
StorageType = "string",
Tags = new[]
{
new AzureNative.AwsConnector.Inputs.TagArgs
{
Key = "string",
Value = "string",
},
},
TdeCredentialArn = "string",
TdeCredentialPassword = "string",
Timezone = "string",
UseDefaultProcessorFeatures = false,
UseLatestRestorableTime = false,
VpcSecurityGroups = new[]
{
"string",
},
},
AwsRegion = "string",
AwsSourceSchema = "string",
AwsTags =
{
{ "string", "string" },
},
PublicCloudConnectorsResourceId = "string",
PublicCloudResourceName = "string",
},
Tags =
{
{ "string", "string" },
},
});
example, err := awsconnector.NewRdsDbInstance(ctx, "rdsDbInstanceResource", &awsconnector.RdsDbInstanceArgs{
ResourceGroupName: pulumi.String("string"),
Location: pulumi.String("string"),
Name: pulumi.String("string"),
Properties: &awsconnector.RdsDBInstancePropertiesArgs{
Arn: pulumi.String("string"),
AwsAccountId: pulumi.String("string"),
AwsProperties: &awsconnector.AwsRdsDBInstancePropertiesArgs{
AllocatedStorage: pulumi.String("string"),
AllowMajorVersionUpgrade: pulumi.Bool(false),
AssociatedRoles: awsconnector.DBInstanceRoleArray{
&awsconnector.DBInstanceRoleArgs{
FeatureName: pulumi.String("string"),
RoleArn: pulumi.String("string"),
},
},
AutoMinorVersionUpgrade: pulumi.Bool(false),
AutomaticBackupReplicationKmsKeyId: pulumi.String("string"),
AutomaticBackupReplicationRegion: pulumi.String("string"),
AvailabilityZone: pulumi.String("string"),
BackupRetentionPeriod: pulumi.Int(0),
CaCertificateIdentifier: pulumi.String("string"),
CertificateDetails: &awsconnector.CertificateDetailsArgs{
CaIdentifier: pulumi.String("string"),
ValidTill: pulumi.String("string"),
},
CertificateRotationRestart: pulumi.Bool(false),
CharacterSetName: pulumi.String("string"),
CopyTagsToSnapshot: pulumi.Bool(false),
CustomIAMInstanceProfile: pulumi.String("string"),
DbClusterIdentifier: pulumi.String("string"),
DbClusterSnapshotIdentifier: pulumi.String("string"),
DbInstanceArn: pulumi.String("string"),
DbInstanceClass: pulumi.String("string"),
DbInstanceIdentifier: pulumi.String("string"),
DbName: pulumi.String("string"),
DbParameterGroupName: pulumi.String("string"),
DbSecurityGroups: pulumi.StringArray{
pulumi.String("string"),
},
DbSnapshotIdentifier: pulumi.String("string"),
DbSubnetGroupName: pulumi.String("string"),
DbSystemId: pulumi.String("string"),
DbiResourceId: 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"),
EnableCloudwatchLogsExports: pulumi.StringArray{
pulumi.String("string"),
},
EnableIAMDatabaseAuthentication: pulumi.Bool(false),
EnablePerformanceInsights: pulumi.Bool(false),
Endpoint: &awsconnector.RdsDbInstanceEndpointArgs{
Address: pulumi.String("string"),
HostedZoneId: pulumi.String("string"),
Port: pulumi.String("string"),
},
Engine: pulumi.String("string"),
EngineVersion: pulumi.String("string"),
Iops: pulumi.Int(0),
KmsKeyId: pulumi.String("string"),
LicenseModel: pulumi.String("string"),
ManageMasterUserPassword: pulumi.Bool(false),
MasterUserPassword: pulumi.String("string"),
MasterUserSecret: &awsconnector.MasterUserSecretArgs{
KmsKeyId: pulumi.String("string"),
SecretArn: pulumi.String("string"),
},
MasterUsername: pulumi.String("string"),
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"),
PerformanceInsightsKMSKeyId: pulumi.String("string"),
PerformanceInsightsRetentionPeriod: pulumi.Int(0),
Port: pulumi.String("string"),
PreferredBackupWindow: pulumi.String("string"),
PreferredMaintenanceWindow: pulumi.String("string"),
ProcessorFeatures: awsconnector.ProcessorFeatureArray{
&awsconnector.ProcessorFeatureArgs{
Name: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
PromotionTier: pulumi.Int(0),
PubliclyAccessible: pulumi.Bool(false),
ReplicaMode: pulumi.String("string"),
RestoreTime: pulumi.String("string"),
SourceDBClusterIdentifier: pulumi.String("string"),
SourceDBInstanceAutomatedBackupsArn: pulumi.String("string"),
SourceDBInstanceIdentifier: pulumi.String("string"),
SourceDbiResourceId: pulumi.String("string"),
SourceRegion: pulumi.String("string"),
StorageEncrypted: pulumi.Bool(false),
StorageThroughput: pulumi.Int(0),
StorageType: pulumi.String("string"),
Tags: awsconnector.TagArray{
&awsconnector.TagArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
TdeCredentialArn: pulumi.String("string"),
TdeCredentialPassword: pulumi.String("string"),
Timezone: pulumi.String("string"),
UseDefaultProcessorFeatures: pulumi.Bool(false),
UseLatestRestorableTime: pulumi.Bool(false),
VpcSecurityGroups: pulumi.StringArray{
pulumi.String("string"),
},
},
AwsRegion: pulumi.String("string"),
AwsSourceSchema: pulumi.String("string"),
AwsTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
PublicCloudConnectorsResourceId: pulumi.String("string"),
PublicCloudResourceName: pulumi.String("string"),
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var rdsDbInstanceResource = new RdsDbInstance("rdsDbInstanceResource", RdsDbInstanceArgs.builder()
.resourceGroupName("string")
.location("string")
.name("string")
.properties(RdsDBInstancePropertiesArgs.builder()
.arn("string")
.awsAccountId("string")
.awsProperties(AwsRdsDBInstancePropertiesArgs.builder()
.allocatedStorage("string")
.allowMajorVersionUpgrade(false)
.associatedRoles(DBInstanceRoleArgs.builder()
.featureName("string")
.roleArn("string")
.build())
.autoMinorVersionUpgrade(false)
.automaticBackupReplicationKmsKeyId("string")
.automaticBackupReplicationRegion("string")
.availabilityZone("string")
.backupRetentionPeriod(0)
.caCertificateIdentifier("string")
.certificateDetails(CertificateDetailsArgs.builder()
.caIdentifier("string")
.validTill("string")
.build())
.certificateRotationRestart(false)
.characterSetName("string")
.copyTagsToSnapshot(false)
.customIAMInstanceProfile("string")
.dbClusterIdentifier("string")
.dbClusterSnapshotIdentifier("string")
.dbInstanceArn("string")
.dbInstanceClass("string")
.dbInstanceIdentifier("string")
.dbName("string")
.dbParameterGroupName("string")
.dbSecurityGroups("string")
.dbSnapshotIdentifier("string")
.dbSubnetGroupName("string")
.dbSystemId("string")
.dbiResourceId("string")
.dedicatedLogVolume(false)
.deleteAutomatedBackups(false)
.deletionProtection(false)
.domain("string")
.domainAuthSecretArn("string")
.domainDnsIps("string")
.domainFqdn("string")
.domainIAMRoleName("string")
.domainOu("string")
.enableCloudwatchLogsExports("string")
.enableIAMDatabaseAuthentication(false)
.enablePerformanceInsights(false)
.endpoint(RdsDbInstanceEndpointArgs.builder()
.address("string")
.hostedZoneId("string")
.port("string")
.build())
.engine("string")
.engineVersion("string")
.iops(0)
.kmsKeyId("string")
.licenseModel("string")
.manageMasterUserPassword(false)
.masterUserPassword("string")
.masterUserSecret(MasterUserSecretArgs.builder()
.kmsKeyId("string")
.secretArn("string")
.build())
.masterUsername("string")
.maxAllocatedStorage(0)
.monitoringInterval(0)
.monitoringRoleArn("string")
.multiAZ(false)
.ncharCharacterSetName("string")
.networkType("string")
.optionGroupName("string")
.performanceInsightsKMSKeyId("string")
.performanceInsightsRetentionPeriod(0)
.port("string")
.preferredBackupWindow("string")
.preferredMaintenanceWindow("string")
.processorFeatures(ProcessorFeatureArgs.builder()
.name("string")
.value("string")
.build())
.promotionTier(0)
.publiclyAccessible(false)
.replicaMode("string")
.restoreTime("string")
.sourceDBClusterIdentifier("string")
.sourceDBInstanceAutomatedBackupsArn("string")
.sourceDBInstanceIdentifier("string")
.sourceDbiResourceId("string")
.sourceRegion("string")
.storageEncrypted(false)
.storageThroughput(0)
.storageType("string")
.tags(TagArgs.builder()
.key("string")
.value("string")
.build())
.tdeCredentialArn("string")
.tdeCredentialPassword("string")
.timezone("string")
.useDefaultProcessorFeatures(false)
.useLatestRestorableTime(false)
.vpcSecurityGroups("string")
.build())
.awsRegion("string")
.awsSourceSchema("string")
.awsTags(Map.of("string", "string"))
.publicCloudConnectorsResourceId("string")
.publicCloudResourceName("string")
.build())
.tags(Map.of("string", "string"))
.build());
rds_db_instance_resource = azure_native.awsconnector.RdsDbInstance("rdsDbInstanceResource",
resource_group_name="string",
location="string",
name="string",
properties={
"arn": "string",
"aws_account_id": "string",
"aws_properties": {
"allocated_storage": "string",
"allow_major_version_upgrade": False,
"associated_roles": [{
"feature_name": "string",
"role_arn": "string",
}],
"auto_minor_version_upgrade": False,
"automatic_backup_replication_kms_key_id": "string",
"automatic_backup_replication_region": "string",
"availability_zone": "string",
"backup_retention_period": 0,
"ca_certificate_identifier": "string",
"certificate_details": {
"ca_identifier": "string",
"valid_till": "string",
},
"certificate_rotation_restart": False,
"character_set_name": "string",
"copy_tags_to_snapshot": False,
"custom_iam_instance_profile": "string",
"db_cluster_identifier": "string",
"db_cluster_snapshot_identifier": "string",
"db_instance_arn": "string",
"db_instance_class": "string",
"db_instance_identifier": "string",
"db_name": "string",
"db_parameter_group_name": "string",
"db_security_groups": ["string"],
"db_snapshot_identifier": "string",
"db_subnet_group_name": "string",
"db_system_id": "string",
"dbi_resource_id": "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",
"enable_cloudwatch_logs_exports": ["string"],
"enable_iam_database_authentication": False,
"enable_performance_insights": False,
"endpoint": {
"address": "string",
"hosted_zone_id": "string",
"port": "string",
},
"engine": "string",
"engine_version": "string",
"iops": 0,
"kms_key_id": "string",
"license_model": "string",
"manage_master_user_password": False,
"master_user_password": "string",
"master_user_secret": {
"kms_key_id": "string",
"secret_arn": "string",
},
"master_username": "string",
"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",
"performance_insights_kms_key_id": "string",
"performance_insights_retention_period": 0,
"port": "string",
"preferred_backup_window": "string",
"preferred_maintenance_window": "string",
"processor_features": [{
"name": "string",
"value": "string",
}],
"promotion_tier": 0,
"publicly_accessible": False,
"replica_mode": "string",
"restore_time": "string",
"source_db_cluster_identifier": "string",
"source_db_instance_automated_backups_arn": "string",
"source_db_instance_identifier": "string",
"source_dbi_resource_id": "string",
"source_region": "string",
"storage_encrypted": False,
"storage_throughput": 0,
"storage_type": "string",
"tags": [{
"key": "string",
"value": "string",
}],
"tde_credential_arn": "string",
"tde_credential_password": "string",
"timezone": "string",
"use_default_processor_features": False,
"use_latest_restorable_time": False,
"vpc_security_groups": ["string"],
},
"aws_region": "string",
"aws_source_schema": "string",
"aws_tags": {
"string": "string",
},
"public_cloud_connectors_resource_id": "string",
"public_cloud_resource_name": "string",
},
tags={
"string": "string",
})
const rdsDbInstanceResource = new azure_native.awsconnector.RdsDbInstance("rdsDbInstanceResource", {
resourceGroupName: "string",
location: "string",
name: "string",
properties: {
arn: "string",
awsAccountId: "string",
awsProperties: {
allocatedStorage: "string",
allowMajorVersionUpgrade: false,
associatedRoles: [{
featureName: "string",
roleArn: "string",
}],
autoMinorVersionUpgrade: false,
automaticBackupReplicationKmsKeyId: "string",
automaticBackupReplicationRegion: "string",
availabilityZone: "string",
backupRetentionPeriod: 0,
caCertificateIdentifier: "string",
certificateDetails: {
caIdentifier: "string",
validTill: "string",
},
certificateRotationRestart: false,
characterSetName: "string",
copyTagsToSnapshot: false,
customIAMInstanceProfile: "string",
dbClusterIdentifier: "string",
dbClusterSnapshotIdentifier: "string",
dbInstanceArn: "string",
dbInstanceClass: "string",
dbInstanceIdentifier: "string",
dbName: "string",
dbParameterGroupName: "string",
dbSecurityGroups: ["string"],
dbSnapshotIdentifier: "string",
dbSubnetGroupName: "string",
dbSystemId: "string",
dbiResourceId: "string",
dedicatedLogVolume: false,
deleteAutomatedBackups: false,
deletionProtection: false,
domain: "string",
domainAuthSecretArn: "string",
domainDnsIps: ["string"],
domainFqdn: "string",
domainIAMRoleName: "string",
domainOu: "string",
enableCloudwatchLogsExports: ["string"],
enableIAMDatabaseAuthentication: false,
enablePerformanceInsights: false,
endpoint: {
address: "string",
hostedZoneId: "string",
port: "string",
},
engine: "string",
engineVersion: "string",
iops: 0,
kmsKeyId: "string",
licenseModel: "string",
manageMasterUserPassword: false,
masterUserPassword: "string",
masterUserSecret: {
kmsKeyId: "string",
secretArn: "string",
},
masterUsername: "string",
maxAllocatedStorage: 0,
monitoringInterval: 0,
monitoringRoleArn: "string",
multiAZ: false,
ncharCharacterSetName: "string",
networkType: "string",
optionGroupName: "string",
performanceInsightsKMSKeyId: "string",
performanceInsightsRetentionPeriod: 0,
port: "string",
preferredBackupWindow: "string",
preferredMaintenanceWindow: "string",
processorFeatures: [{
name: "string",
value: "string",
}],
promotionTier: 0,
publiclyAccessible: false,
replicaMode: "string",
restoreTime: "string",
sourceDBClusterIdentifier: "string",
sourceDBInstanceAutomatedBackupsArn: "string",
sourceDBInstanceIdentifier: "string",
sourceDbiResourceId: "string",
sourceRegion: "string",
storageEncrypted: false,
storageThroughput: 0,
storageType: "string",
tags: [{
key: "string",
value: "string",
}],
tdeCredentialArn: "string",
tdeCredentialPassword: "string",
timezone: "string",
useDefaultProcessorFeatures: false,
useLatestRestorableTime: false,
vpcSecurityGroups: ["string"],
},
awsRegion: "string",
awsSourceSchema: "string",
awsTags: {
string: "string",
},
publicCloudConnectorsResourceId: "string",
publicCloudResourceName: "string",
},
tags: {
string: "string",
},
});
type: azure-native:awsconnector:RdsDbInstance
properties:
location: string
name: string
properties:
arn: string
awsAccountId: string
awsProperties:
allocatedStorage: string
allowMajorVersionUpgrade: false
associatedRoles:
- featureName: string
roleArn: string
autoMinorVersionUpgrade: false
automaticBackupReplicationKmsKeyId: string
automaticBackupReplicationRegion: string
availabilityZone: string
backupRetentionPeriod: 0
caCertificateIdentifier: string
certificateDetails:
caIdentifier: string
validTill: string
certificateRotationRestart: false
characterSetName: string
copyTagsToSnapshot: false
customIAMInstanceProfile: string
dbClusterIdentifier: string
dbClusterSnapshotIdentifier: string
dbInstanceArn: string
dbInstanceClass: string
dbInstanceIdentifier: string
dbName: string
dbParameterGroupName: string
dbSecurityGroups:
- string
dbSnapshotIdentifier: string
dbSubnetGroupName: string
dbSystemId: string
dbiResourceId: string
dedicatedLogVolume: false
deleteAutomatedBackups: false
deletionProtection: false
domain: string
domainAuthSecretArn: string
domainDnsIps:
- string
domainFqdn: string
domainIAMRoleName: string
domainOu: string
enableCloudwatchLogsExports:
- string
enableIAMDatabaseAuthentication: false
enablePerformanceInsights: false
endpoint:
address: string
hostedZoneId: string
port: string
engine: string
engineVersion: string
iops: 0
kmsKeyId: string
licenseModel: string
manageMasterUserPassword: false
masterUserPassword: string
masterUserSecret:
kmsKeyId: string
secretArn: string
masterUsername: string
maxAllocatedStorage: 0
monitoringInterval: 0
monitoringRoleArn: string
multiAZ: false
ncharCharacterSetName: string
networkType: string
optionGroupName: string
performanceInsightsKMSKeyId: string
performanceInsightsRetentionPeriod: 0
port: string
preferredBackupWindow: string
preferredMaintenanceWindow: string
processorFeatures:
- name: string
value: string
promotionTier: 0
publiclyAccessible: false
replicaMode: string
restoreTime: string
sourceDBClusterIdentifier: string
sourceDBInstanceAutomatedBackupsArn: string
sourceDBInstanceIdentifier: string
sourceDbiResourceId: string
sourceRegion: string
storageEncrypted: false
storageThroughput: 0
storageType: string
tags:
- key: string
value: string
tdeCredentialArn: string
tdeCredentialPassword: string
timezone: string
useDefaultProcessorFeatures: false
useLatestRestorableTime: false
vpcSecurityGroups:
- string
awsRegion: string
awsSourceSchema: string
awsTags:
string: string
publicCloudConnectorsResourceId: string
publicCloudResourceName: string
resourceGroupName: string
tags:
string: string
RdsDbInstance Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The RdsDbInstance resource accepts the following input properties:
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Location string
- The geo-location where the resource lives
- Name string
- Name of RdsDBInstance
- Properties
Pulumi.
Azure Native. Aws Connector. Inputs. Rds DBInstance Properties - The resource-specific properties for this resource.
- Dictionary<string, string>
- Resource tags.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Location string
- The geo-location where the resource lives
- Name string
- Name of RdsDBInstance
- Properties
Rds
DBInstance Properties Args - The resource-specific properties for this resource.
- map[string]string
- Resource tags.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- location String
- The geo-location where the resource lives
- name String
- Name of RdsDBInstance
- properties
Rds
DBInstance Properties - The resource-specific properties for this resource.
- Map<String,String>
- Resource tags.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- location string
- The geo-location where the resource lives
- name string
- Name of RdsDBInstance
- properties
Rds
DBInstance Properties - The resource-specific properties for this resource.
- {[key: string]: string}
- Resource tags.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- location str
- The geo-location where the resource lives
- name str
- Name of RdsDBInstance
- properties
Rds
DBInstance Properties Args - The resource-specific properties for this resource.
- Mapping[str, str]
- Resource tags.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- location String
- The geo-location where the resource lives
- name String
- Name of RdsDBInstance
- properties Property Map
- The resource-specific properties for this resource.
- Map<String>
- Resource tags.
Outputs
All input properties are implicitly available as output properties. Additionally, the RdsDbInstance resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- System
Data Pulumi.Azure Native. Aws Connector. Outputs. System Data Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Id string
- The provider-assigned unique ID for this managed resource.
- System
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- id String
- The provider-assigned unique ID for this managed resource.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- id string
- The provider-assigned unique ID for this managed resource.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- id str
- The provider-assigned unique ID for this managed resource.
- system_
data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- id String
- The provider-assigned unique ID for this managed resource.
- system
Data Property Map - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Supporting Types
AwsRdsDBInstanceProperties, AwsRdsDBInstancePropertiesArgs
- Allocated
Storage string - The amount of storage in gibibytes (GiB) to be initially allocated for the database instance. If any value is set in the
Iops
parameter,AllocatedStorage
must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase theIops
value (in 1,000 IOPS increments), then you must also increase theAllocatedStorage
value (in 100-GiB increments). Amazon Aurora Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume. Db2 Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000. + Provisioned IOPS storage (io1): Must be an integer from 100 to 64000. MySQL Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. MariaDB Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. PostgreSQL Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. Oracle Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 10 to 3072. SQL Server Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): + Enterprise and Standard editions: Must be an integer from 20 to 16384. + Web and Express editions: Must be an integer from 20 to 16384. + Provisioned IOPS storage (io1): + Enterprise and Standard editions: Must be an integer from 20 to 16384. + Web and Express editions: Must be an integer from 20 to 16384. + Magnetic storage (standard): + Enterprise and Standard editions: Must be an integer from 20 to 1024. + Web and Express editions: Must be an integer from 20 to 1024. - Allow
Major boolVersion Upgrade - A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Constraints: Major version upgrades must be allowed when specifying a value for the
EngineVersion
parameter that is a different major version than the DB instance's current version. - Associated
Roles List<Pulumi.Azure Native. Aws Connector. Inputs. DBInstance Role> - The IAMlong (IAM) roles associated with the DB instance. Amazon Aurora Not applicable. The associated roles are managed by the DB cluster.
- Auto
Minor boolVersion Upgrade - A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.
- Automatic
Backup stringReplication Kms Key Id - Property automaticBackupReplicationKmsKeyId
- Automatic
Backup stringReplication Region - The destination region for the backup replication of the DB instance. For more info, see Replicating automated backups to another Region in the Amazon RDS User Guide.
- Availability
Zone string - The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see Regions and Availability Zones. For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one. Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region. Constraints: + The
AvailabilityZone
parameter can't be specified if the DB instance is a Multi-AZ deployment. + The specified Availability Zone must be in the same AWS-Region as the current endpoint. Example:us-east-1d
- Backup
Retention intPeriod - The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Amazon Aurora Not applicable. The retention period for automated backups is managed by the DB cluster. Default: 1 Constraints: + Must be a value from 0 to 35 + Can't be set to 0 if the DB instance is a source to read replicas
- Ca
Certificate stringIdentifier - The identifier of the CA certificate for this DB instance. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- Certificate
Details Pulumi.Azure Native. Aws Connector. Inputs. Certificate Details - The details of the DB instance's server certificate. Returns the details of the DB instance’s server certificate. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- Certificate
Rotation boolRestart - Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate. By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. Set this parameter only if you are not using SSL/TLS to connect to the DB instance. If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate: + For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide. + For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide. This setting doesn't apply to RDS Custom DB instances.
- Character
Set stringName - For supported engines, indicates that the DB instance should be associated with the specified character set. Amazon Aurora Not applicable. The character set is managed by the DB cluster. For more information, see AWS::RDS::DBCluster.
- bool
- Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
- Custom
IAMInstance stringProfile - The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. This setting is required for RDS Custom. Constraints: + The profile must exist in your account. + The profile must have an IAM role that Amazon EC2 has permissions to assume. + The instance profile name and the associated IAM role name must start with the prefix
AWSRDSCustom
. For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide. - Db
Cluster stringIdentifier - The identifier of the DB cluster that the instance will belong to.
- Db
Cluster stringSnapshot Identifier - The identifier for the Multi-AZ DB cluster snapshot to restore from. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide. Constraints: + Must match the identifier of an existing Multi-AZ DB cluster snapshot. + Can't be specified when
DBSnapshotIdentifier
is specified. + Must be specified whenDBSnapshotIdentifier
isn't specified. + If you are restoring from a shared manual Multi-AZ DB cluster snapshot, theDBClusterSnapshotIdentifier
must be the ARN of the shared snapshot. + Can't be the identifier of an Aurora DB cluster snapshot. - Db
Instance stringArn - Property dbInstanceArn
- Db
Instance stringClass - The compute and memory capacity of the DB instance, for example
db.m5.large
. Not all DB instance classes are available in all AWS-Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB instance classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide. - Db
Instance stringIdentifier - A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see Name Type. For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
- Db
Name string - The meaning of this parameter differs according to the database engine you use. If you specify the
DBSnapshotIdentifier
property, this property only applies to RDS for Oracle. Amazon Aurora Not applicable. The database name is managed by the DB cluster. Db2 The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. Constraints: + Must contain 1 to 64 letters or numbers. + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + Can't be a word reserved by the specified database engine. MySQL 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. Constraints: + Must contain 1 to 64 letters or numbers. + Can't be a word reserved by the specified database engine MariaDB 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. Constraints: + Must contain 1 to 64 letters or numbers. + Can't be a word reserved by the specified database engine PostgreSQL The name of the database to create when the DB instance is created. If this parameter is not specified, the defaultpostgres
database is created in the DB instance. Constraints: + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + Must contain 1 to 63 characters. + Can't be a word reserved by the specified database engine Oracle The Oracle System ID (SID) of the created DB instance. If you specifynull
, the default valueORCL
is used. You can't specify the string NULL, or any other reserved word, forDBName
. Default:ORCL
Constraints: + Can't be longer than 8 characters SQL Server Not applicable. Must be null. - Db
Parameter stringGroup Name - The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template. To list all of the available DB parameter group names, use the following command:
aws rds describe-db-parameter-groups --query 'DBParameterGroups[].DBParameterGroupName' --output text
If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot. If you don't specify a value forDBParameterGroupName
property, the default DB parameter group for the specified engine and engine version is used. - Db
Security List<string>Groups - A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template. If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups. If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations: +
AllocatedStorage
+AutoMinorVersionUpgrade
+AvailabilityZone
+BackupRetentionPeriod
+CharacterSetName
+DBInstanceClass
+DBName
+DBParameterGroupName
+DBSecurityGroups
+DBSubnetGroupName
+Engine
+EngineVersion
+Iops
+LicenseModel
+MasterUsername
+MasterUserPassword
+MultiAZ
+OptionGroupName
+PreferredBackupWindow
+PreferredMaintenanceWindow
All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such asStorageType
,StorageEncrypted
, orKmsKeyId
. If you're already using theDBSecurityGroups
property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance. - Db
Snapshot stringIdentifier - The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot. By specifying this property, you can create a DB instance from the specified DB snapshot. If the
DBSnapshotIdentifier
property is an empty string or theAWS::RDS::DBInstance
declaration has noDBSnapshotIdentifier
property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack. Some DB instance properties aren't valid when you restore from a snapshot, such as theMasterUsername
andMasterUserPassword
properties. For information about the properties that you can specify, see theRestoreDBInstanceFromDBSnapshot
action in the Amazon RDS API Reference. After you restore a DB instance with aDBSnapshotIdentifier
property, you must specify the sameDBSnapshotIdentifier
property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify theDBSnapshotIdentifier
property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specifiedDBSnapshotIdentifier
property, and the original DB instance is deleted. If you specify theDBSnapshotIdentifier
property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties: +CharacterSetName
+DBClusterIdentifier
+DBName
+DeleteAutomatedBackups
+EnablePerformanceInsights
+KmsKeyId
+MasterUsername
+MasterUserPassword
+PerformanceInsightsKMSKeyId
+PerformanceInsightsRetentionPeriod
+PromotionTier
+SourceDBInstanceIdentifier
+SourceRegion
+StorageEncrypted
(for an encrypted snapshot) +Timezone
Amazon Aurora Not applicable. Snapshot restore is managed by the DB cluster. - Db
Subnet stringGroup Name - A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC. If there's no DB subnet group, then the DB instance isn't a VPC DB instance. For more information about using Amazon RDS in a VPC, see Using Amazon RDS with Amazon Virtual Private Cloud (VPC) in the Amazon RDS User Guide. Amazon Aurora Not applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
- Db
System stringId - The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term 'Oracle database instance' refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to
RDSCDB
. The Oracle SID is also the name of your CDB. - Dbi
Resource stringId - Property dbiResourceId
- Dedicated
Log boolVolume - Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
- Delete
Automated boolBackups - A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted. Amazon Aurora Not applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted.
- Deletion
Protection bool - A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance. Amazon Aurora Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see
CreateDBCluster
. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster. - Domain string
- The Active Directory directory ID to create the DB instance in. Currently, only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see Kerberos Authentication in the Amazon RDS User Guide.
- Domain
Auth stringSecret Arn - The ARN for the Secrets Manager secret with the credentials for the user joining the domain. Example:
arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
- Domain
Dns List<string>Ips - The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers. Constraints: + 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. Example:
123.124.125.126,234.235.236.237
- Domain
Fqdn string - The fully qualified domain name (FQDN) of an Active Directory domain. Constraints: + Can't be longer than 64 characters. Example:
mymanagedADtest.mymanagedAD.mydomain
- Domain
IAMRole stringName - The name of the IAM role to use when making API calls to the Directory Service. This setting doesn't apply to the following DB instances: + Amazon Aurora (The domain is managed by the DB cluster.) + RDS Custom
- Domain
Ou string - The Active Directory organizational unit for your DB instance to join. Constraints: + Must be in the distinguished name format. + Can't be longer than 64 characters. Example:
OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
- Enable
Cloudwatch List<string>Logs Exports - The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service User Guide. Amazon Aurora Not applicable. CloudWatch Logs exports are managed by the DB cluster. Db2 Valid values:
diag.log
,notify.log
MariaDB Valid values:audit
,error
,general
,slowquery
Microsoft SQL Server Valid values:agent
,error
MySQL Valid values:audit
,error
,general
,slowquery
Oracle Valid values:alert
,audit
,listener
,trace
,oemagent
PostgreSQL Valid values:postgresql
,upgrade
- Enable
IAMDatabase boolAuthentication - A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see IAM Database Authentication for MariaDB, MySQL, and PostgreSQL in the Amazon RDS User Guide. Amazon Aurora Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
- Enable
Performance boolInsights - Specifies whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom DB instances.
- Endpoint
Pulumi.
Azure Native. Aws Connector. Inputs. Rds Db Instance Endpoint - The connection endpoint for the DB instance. The endpoint might not be shown for instances with the status of
creating
. This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions: +CreateDBInstance
+DescribeDBInstances
+DeleteDBInstance
For the data structure that represents Amazon Aurora DB cluster endpoints, seeDBClusterEndpoint
. - Engine string
- The name of the database engine to use for this DB instance. Not every database engine is available in every AWS Region. This property is required when creating a DB instance. You can change the architecture of an Oracle database from the non-container database (CDB) architecture to the CDB architecture by updating the
Engine
value in your templates fromoracle-ee
ororacle-ee-cdb
tooracle-se2-cdb
. Converting to the CDB architecture requires an interruption. Valid Values: +aurora-mysql
(for Aurora MySQL DB instances) +aurora-postgresql
(for Aurora PostgreSQL DB instances) +custom-oracle-ee
(for RDS Custom for Oracle DB instances) +custom-oracle-ee-cdb
(for RDS Custom for Oracle DB instances) +custom-sqlserver-ee
(for RDS Custom for SQL Server DB instances) +custom-sqlserver-se
(for RDS Custom for SQL Server DB instances) +custom-sqlserver-web
(for RDS Custom for SQL Server DB instances) +db2-ae
+db2-se
+mariadb
+mysql
+oracle-ee
+oracle-ee-cdb
+oracle-se2
+oracle-se2-cdb
+postgres
+sqlserver-ee
+sqlserver-se
+sqlserver-ex
+sqlserver-web
- Engine
Version string - The version number of the database engine to use. For a list of valid engine versions, use the
DescribeDBEngineVersions
action. The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region. Amazon Aurora Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. Db2 See Amazon RDS for Db2 in the Amazon RDS User Guide. MariaDB See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide. Microsoft SQL Server See Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide. MySQL See MySQL on Amazon RDS Versions in the Amazon RDS User Guide. Oracle See Oracle Database Engine Release Notes in the Amazon RDS User Guide. PostgreSQL See Supported PostgreSQL Database Versions in the Amazon RDS User Guide. - Iops int
- The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide. If you specify
io1
for theStorageType
property, then you must also specify theIops
property. Constraints: + For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance. + For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance. - Kms
Key stringId - The ARN of the AWS KMS key that's used to encrypt the DB instance, such as
arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef
. If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default KMS key. If you specify this property, you must set the StorageEncrypted property to true. If you specify theSourceDBInstanceIdentifier
property, the value is inherited from the source DB instance if the read replica is created in the same region. If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region. If you specify theSnapshotIdentifier
property, theStorageEncrypted
property value is inherited from the snapshot, and if the DB instance is encrypted, the specifiedKmsKeyId
property is used. If you specifyDBSecurityGroups
, AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see Using Amazon RDS with Amazon VPC in the Amazon RDS User Guide. Amazon Aurora Not applicable. The KMS key identifier is managed by the DB cluster. - License
Model string - License model information for this DB instance. Valid Values: + Aurora MySQL -
general-public-license
+ Aurora PostgreSQL -postgresql-license
+ RDS for Db2 -bring-your-own-license
. For more information about RDS for Db2 licensing, see in the Amazon RDS User Guide. + 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
orlicense-included
+ RDS for PostgreSQL -postgresql-license
If you've specifiedDBSecurityGroups
and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability. - Manage
Master boolUser Password - Specifies whether to manage the master user password with AWS Secrets Manager. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide. Constraints: + Can't manage the master user password with AWS Secrets Manager if
MasterUserPassword
is specified. - Master
User stringPassword - The password for the master user. The password can include any printable ASCII character except '/', ''', or '@'. Amazon Aurora Not applicable. The password for the master user is managed by the DB cluster. RDS for Db2 Must contain from 8 to 255 characters. RDS for MariaDB Constraints: Must contain from 8 to 41 characters. RDS for Microsoft SQL Server Constraints: Must contain from 8 to 128 characters. RDS for MySQL Constraints: Must contain from 8 to 41 characters. RDS for Oracle Constraints: Must contain from 8 to 30 characters. RDS for PostgreSQL Constraints: Must contain from 8 to 128 characters.
- Master
User Pulumi.Secret Azure Native. Aws Connector. Inputs. Master User Secret - The secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide. The
MasterUserSecret
return value specifies the secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide and Password management with Secrets Manager in the Amazon Aurora User Guide. - Master
Username string - The master user name for the DB instance. If you specify the
SourceDBInstanceIdentifier
orDBSnapshotIdentifier
property, don't specify this property. The value is inherited from the source DB instance or snapshot. When migrating a self-managed Db2 database, we recommend that you use the same master username as your self-managed Db2 instance name. Amazon Aurora Not applicable. The name for the master user is managed by the DB cluster. RDS for Db2 Constraints: + Must be 1 to 16 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for MariaDB Constraints: + Must be 1 to 16 letters or numbers. + Can't be a reserved word for the chosen database engine. RDS for Microsoft SQL Server Constraints: + Must be 1 to 128 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for MySQL Constraints: + Must be 1 to 16 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for Oracle Constraints: + Must be 1 to 30 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for PostgreSQL Constraints: + Must be 1 to 63 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. - Max
Allocated intStorage - The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide. This setting doesn't apply to the following DB instances: + Amazon Aurora (Storage is managed by the DB cluster.) + RDS Custom
- Monitoring
Interval int - The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0. If
MonitoringRoleArn
is specified, then you must setMonitoringInterval
to a value other than 0. This setting doesn't apply to RDS Custom. 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 Amazon CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide. IfMonitoringInterval
is set to a value other than0
, then you must supply aMonitoringRoleArn
value. This setting doesn't apply to RDS Custom DB instances. - Multi
AZ bool - Specifies whether the database instance is a Multi-AZ DB instance deployment. You can't set the
AvailabilityZone
parameter if theMultiAZ
parameter is set to true. For more information, see Multi-AZ deployments for high availability in the Amazon RDS User Guide. Amazon Aurora Not applicable. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require theMultiAZ
option to be set. - Nchar
Character stringSet Name - The name of the NCHAR character set for the Oracle DB instance. This setting doesn't apply to RDS Custom DB instances.
- Network
Type string - The network type of the DB instance. Valid values: +
IPV4
+DUAL
The network type is determined by theDBSubnetGroup
specified for the DB instance. ADBSubnetGroup
can support only the IPv4 protocol or the IPv4 and IPv6 protocols (DUAL
). For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide. - Option
Group stringName - Indicates that the DB instance should be associated with the specified option group. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance.
- Performance
Insights stringKMSKey Id - The AWS KMS key identifier for encryption of Performance Insights data. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for
PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region. For information about enabling Performance Insights, see EnablePerformanceInsights. - Performance
Insights intRetention Period - The number of days to retain Performance Insights data. This setting doesn't apply to RDS Custom DB instances. Valid Values: +
7
+ month * 31, where month is a number of months from 1-23. Examples:93
(3 months * 31),341
(11 months * 31),589
(19 months * 31) +731
Default:7
days If you specify a retention period that isn't valid, such as94
, Amazon RDS returns an error. - Port string
- The port number on which the database accepts connections. Amazon Aurora Not applicable. The port number is managed by the DB cluster. Db2 Default value:
50000
- Preferred
Backup stringWindow - The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod
parameter. For more information, see Backup Window in the Amazon RDS User Guide. Constraints: + Must be in the formathh24:mi-hh24:mi
. + Must be in Universal Coordinated Time (UTC). + Must not conflict with the preferred maintenance window. + Must be at least 30 minutes. Amazon Aurora Not applicable. The daily time range for creating automated backups is managed by the DB cluster. - Preferred
Maintenance stringWindow - The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format:
ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window in the Amazon RDS User Guide. This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately. Constraints: Minimum 30-minute window. - Processor
Features List<Pulumi.Azure Native. Aws Connector. Inputs. Processor Feature> - The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
- Promotion
Tier int - The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide. This setting doesn't apply to RDS Custom DB instances. Default:
1
Valid Values:0 - 15
- Publicly
Accessible bool - Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address. The default behavior value depends on your VPC setup and the database subnet group. For more information, see the
PubliclyAccessible
parameter in the CreateDBInstance in the Amazon RDS API Reference. - Replica
Mode string - The open mode of an Oracle read replica. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide. This setting is only supported in RDS for Oracle. Default:
open-read-only
Valid Values:open-read-only
ormounted
- Restore
Time string - The date and time to restore from. Constraints: + Must be a time in Universal Coordinated Time (UTC) format. + Must be before the latest restorable time for the DB instance. + Can't be specified if the
UseLatestRestorableTime
parameter is enabled. Example:2009-09-07T23:45:00Z
- Source
DBCluster stringIdentifier - The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas. Constraints: + Must be the identifier of an existing Multi-AZ DB cluster. + Can't be specified if the
SourceDBInstanceIdentifier
parameter is also specified. + The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0. + The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported. - Source
DBInstance stringAutomated Backups Arn - The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example,
arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE
. This setting doesn't apply to RDS Custom. - Source
DBInstance stringIdentifier - If you want to create a read replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of read replicas. For more information, see Working with Read Replicas in the Amazon RDS User Guide. For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide. The
SourceDBInstanceIdentifier
property determines whether a DB instance is a read replica. If you remove theSourceDBInstanceIdentifier
property from your template and then update your stack, AWS CloudFormation promotes the Read Replica to a standalone DB instance. + If you specify a source DB instance that uses VPC security groups, we recommend that you specify theVPCSecurityGroups
property. If you don't specify the property, the read replica inherits the value of theVPCSecurityGroups
property from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica'sVPCSecurityGroups
property to the default value because it's not defined in the stack's template. This change might cause unexpected issues. + Read replicas don't support deletion policies. AWS CloudFormation ignores any deletion policy that's associated with a read replica. + If you specifySourceDBInstanceIdentifier
, don't specify theDBSnapshotIdentifier
property. You can't create a read replica from a snapshot. + Don't set theBackupRetentionPeriod
,DBName
,MasterUsername
,MasterUserPassword
, andPreferredBackupWindow
properties. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas. + If the source DB instance is in a different region than the read replica, specify the source region inSourceRegion
, and specify an ARN for a valid DB instance inSourceDBInstanceIdentifier
. For more information, see Constructing a Amazon RDS Amazon Resource Name (ARN) in the Amazon RDS User Guide. + For DB instances in Amazon Aurora clusters, don't specify this property. Amazon RDS automatically assigns writer and reader DB instances. - Source
Dbi stringResource Id - The resource ID of the source DB instance from which to restore.
- Source
Region string - The ID of the region that contains the source DB instance for the read replica.
- Storage
Encrypted bool - A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. If you specify the
KmsKeyId
property, then you must enable encryption. If you specify theSourceDBInstanceIdentifier
property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specifiedKmsKeyId
property is used. If you specify theDBSnapshotIdentifier
and the specified snapshot is encrypted, don't specify this property. The value is inherited from the snapshot, and the specifiedKmsKeyId
property is used. If you specify theDBSnapshotIdentifier
and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB instance is encrypted. Specify theKmsKeyId
property for the KMS key to use for encryption. If you don't want the restored DB instance to be encrypted, then don't set this property or set it tofalse
. Amazon Aurora Not applicable. The encryption for DB instances is managed by the DB cluster. - Storage
Throughput int - Specifies the storage throughput value for the DB instance. This setting applies only to the
gp3
storage type. This setting doesn't apply to RDS Custom or Amazon Aurora. - Storage
Type string - The storage type to associate with the DB instance. If you specify
io1
,io2
, orgp3
, you must also include a value for theIops
parameter. This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster. Valid Values:gp2 | gp3 | io1 | io2 | standard
Default:io1
, if theIops
parameter is specified. Otherwise,gp2
. - List<Pulumi.
Azure Native. Aws Connector. Inputs. Tag> - An optional array of key-value pairs to apply to this DB instance.
- Tde
Credential stringArn - Property tdeCredentialArn
- Tde
Credential stringPassword - Property tdeCredentialPassword
- Timezone string
- The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.
- Use
Default boolProcessor Features - Specifies whether the DB instance class of the DB instance uses its default processor features. This setting doesn't apply to RDS Custom DB instances.
- Use
Latest boolRestorable Time - Specifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time. Constraints: + Can't be specified if the
RestoreTime
parameter is provided. - Vpc
Security List<string>Groups - A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to AWS::EC2::SecurityGroup resources created in the template. If you plan to update the resource, don't specify VPC security groups in a shared VPC. If you set
VPCSecurityGroups
, you must not set DBSecurityGroups, and vice versa. You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind: + You can't revert to using an RDS security group after you establish a VPC security group membership. + When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group. + To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the DBSecurityGroups property. To avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template. Amazon Aurora Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
- Allocated
Storage string - The amount of storage in gibibytes (GiB) to be initially allocated for the database instance. If any value is set in the
Iops
parameter,AllocatedStorage
must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase theIops
value (in 1,000 IOPS increments), then you must also increase theAllocatedStorage
value (in 100-GiB increments). Amazon Aurora Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume. Db2 Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000. + Provisioned IOPS storage (io1): Must be an integer from 100 to 64000. MySQL Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. MariaDB Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. PostgreSQL Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. Oracle Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 10 to 3072. SQL Server Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): + Enterprise and Standard editions: Must be an integer from 20 to 16384. + Web and Express editions: Must be an integer from 20 to 16384. + Provisioned IOPS storage (io1): + Enterprise and Standard editions: Must be an integer from 20 to 16384. + Web and Express editions: Must be an integer from 20 to 16384. + Magnetic storage (standard): + Enterprise and Standard editions: Must be an integer from 20 to 1024. + Web and Express editions: Must be an integer from 20 to 1024. - Allow
Major boolVersion Upgrade - A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Constraints: Major version upgrades must be allowed when specifying a value for the
EngineVersion
parameter that is a different major version than the DB instance's current version. - Associated
Roles []DBInstanceRole - The IAMlong (IAM) roles associated with the DB instance. Amazon Aurora Not applicable. The associated roles are managed by the DB cluster.
- Auto
Minor boolVersion Upgrade - A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.
- Automatic
Backup stringReplication Kms Key Id - Property automaticBackupReplicationKmsKeyId
- Automatic
Backup stringReplication Region - The destination region for the backup replication of the DB instance. For more info, see Replicating automated backups to another Region in the Amazon RDS User Guide.
- Availability
Zone string - The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see Regions and Availability Zones. For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one. Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region. Constraints: + The
AvailabilityZone
parameter can't be specified if the DB instance is a Multi-AZ deployment. + The specified Availability Zone must be in the same AWS-Region as the current endpoint. Example:us-east-1d
- Backup
Retention intPeriod - The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Amazon Aurora Not applicable. The retention period for automated backups is managed by the DB cluster. Default: 1 Constraints: + Must be a value from 0 to 35 + Can't be set to 0 if the DB instance is a source to read replicas
- Ca
Certificate stringIdentifier - The identifier of the CA certificate for this DB instance. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- Certificate
Details CertificateDetails - The details of the DB instance's server certificate. Returns the details of the DB instance’s server certificate. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- Certificate
Rotation boolRestart - Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate. By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. Set this parameter only if you are not using SSL/TLS to connect to the DB instance. If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate: + For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide. + For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide. This setting doesn't apply to RDS Custom DB instances.
- Character
Set stringName - For supported engines, indicates that the DB instance should be associated with the specified character set. Amazon Aurora Not applicable. The character set is managed by the DB cluster. For more information, see AWS::RDS::DBCluster.
- bool
- Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
- Custom
IAMInstance stringProfile - The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. This setting is required for RDS Custom. Constraints: + The profile must exist in your account. + The profile must have an IAM role that Amazon EC2 has permissions to assume. + The instance profile name and the associated IAM role name must start with the prefix
AWSRDSCustom
. For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide. - Db
Cluster stringIdentifier - The identifier of the DB cluster that the instance will belong to.
- Db
Cluster stringSnapshot Identifier - The identifier for the Multi-AZ DB cluster snapshot to restore from. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide. Constraints: + Must match the identifier of an existing Multi-AZ DB cluster snapshot. + Can't be specified when
DBSnapshotIdentifier
is specified. + Must be specified whenDBSnapshotIdentifier
isn't specified. + If you are restoring from a shared manual Multi-AZ DB cluster snapshot, theDBClusterSnapshotIdentifier
must be the ARN of the shared snapshot. + Can't be the identifier of an Aurora DB cluster snapshot. - Db
Instance stringArn - Property dbInstanceArn
- Db
Instance stringClass - The compute and memory capacity of the DB instance, for example
db.m5.large
. Not all DB instance classes are available in all AWS-Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB instance classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide. - Db
Instance stringIdentifier - A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see Name Type. For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
- Db
Name string - The meaning of this parameter differs according to the database engine you use. If you specify the
DBSnapshotIdentifier
property, this property only applies to RDS for Oracle. Amazon Aurora Not applicable. The database name is managed by the DB cluster. Db2 The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. Constraints: + Must contain 1 to 64 letters or numbers. + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + Can't be a word reserved by the specified database engine. MySQL 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. Constraints: + Must contain 1 to 64 letters or numbers. + Can't be a word reserved by the specified database engine MariaDB 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. Constraints: + Must contain 1 to 64 letters or numbers. + Can't be a word reserved by the specified database engine PostgreSQL The name of the database to create when the DB instance is created. If this parameter is not specified, the defaultpostgres
database is created in the DB instance. Constraints: + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + Must contain 1 to 63 characters. + Can't be a word reserved by the specified database engine Oracle The Oracle System ID (SID) of the created DB instance. If you specifynull
, the default valueORCL
is used. You can't specify the string NULL, or any other reserved word, forDBName
. Default:ORCL
Constraints: + Can't be longer than 8 characters SQL Server Not applicable. Must be null. - Db
Parameter stringGroup Name - The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template. To list all of the available DB parameter group names, use the following command:
aws rds describe-db-parameter-groups --query 'DBParameterGroups[].DBParameterGroupName' --output text
If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot. If you don't specify a value forDBParameterGroupName
property, the default DB parameter group for the specified engine and engine version is used. - Db
Security []stringGroups - A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template. If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups. If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations: +
AllocatedStorage
+AutoMinorVersionUpgrade
+AvailabilityZone
+BackupRetentionPeriod
+CharacterSetName
+DBInstanceClass
+DBName
+DBParameterGroupName
+DBSecurityGroups
+DBSubnetGroupName
+Engine
+EngineVersion
+Iops
+LicenseModel
+MasterUsername
+MasterUserPassword
+MultiAZ
+OptionGroupName
+PreferredBackupWindow
+PreferredMaintenanceWindow
All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such asStorageType
,StorageEncrypted
, orKmsKeyId
. If you're already using theDBSecurityGroups
property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance. - Db
Snapshot stringIdentifier - The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot. By specifying this property, you can create a DB instance from the specified DB snapshot. If the
DBSnapshotIdentifier
property is an empty string or theAWS::RDS::DBInstance
declaration has noDBSnapshotIdentifier
property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack. Some DB instance properties aren't valid when you restore from a snapshot, such as theMasterUsername
andMasterUserPassword
properties. For information about the properties that you can specify, see theRestoreDBInstanceFromDBSnapshot
action in the Amazon RDS API Reference. After you restore a DB instance with aDBSnapshotIdentifier
property, you must specify the sameDBSnapshotIdentifier
property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify theDBSnapshotIdentifier
property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specifiedDBSnapshotIdentifier
property, and the original DB instance is deleted. If you specify theDBSnapshotIdentifier
property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties: +CharacterSetName
+DBClusterIdentifier
+DBName
+DeleteAutomatedBackups
+EnablePerformanceInsights
+KmsKeyId
+MasterUsername
+MasterUserPassword
+PerformanceInsightsKMSKeyId
+PerformanceInsightsRetentionPeriod
+PromotionTier
+SourceDBInstanceIdentifier
+SourceRegion
+StorageEncrypted
(for an encrypted snapshot) +Timezone
Amazon Aurora Not applicable. Snapshot restore is managed by the DB cluster. - Db
Subnet stringGroup Name - A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC. If there's no DB subnet group, then the DB instance isn't a VPC DB instance. For more information about using Amazon RDS in a VPC, see Using Amazon RDS with Amazon Virtual Private Cloud (VPC) in the Amazon RDS User Guide. Amazon Aurora Not applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
- Db
System stringId - The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term 'Oracle database instance' refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to
RDSCDB
. The Oracle SID is also the name of your CDB. - Dbi
Resource stringId - Property dbiResourceId
- Dedicated
Log boolVolume - Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
- Delete
Automated boolBackups - A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted. Amazon Aurora Not applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted.
- Deletion
Protection bool - A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance. Amazon Aurora Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see
CreateDBCluster
. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster. - Domain string
- The Active Directory directory ID to create the DB instance in. Currently, only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see Kerberos Authentication in the Amazon RDS User Guide.
- Domain
Auth stringSecret Arn - The ARN for the Secrets Manager secret with the credentials for the user joining the domain. Example:
arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
- Domain
Dns []stringIps - The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers. Constraints: + 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. Example:
123.124.125.126,234.235.236.237
- Domain
Fqdn string - The fully qualified domain name (FQDN) of an Active Directory domain. Constraints: + Can't be longer than 64 characters. Example:
mymanagedADtest.mymanagedAD.mydomain
- Domain
IAMRole stringName - The name of the IAM role to use when making API calls to the Directory Service. This setting doesn't apply to the following DB instances: + Amazon Aurora (The domain is managed by the DB cluster.) + RDS Custom
- Domain
Ou string - The Active Directory organizational unit for your DB instance to join. Constraints: + Must be in the distinguished name format. + Can't be longer than 64 characters. Example:
OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
- Enable
Cloudwatch []stringLogs Exports - The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service User Guide. Amazon Aurora Not applicable. CloudWatch Logs exports are managed by the DB cluster. Db2 Valid values:
diag.log
,notify.log
MariaDB Valid values:audit
,error
,general
,slowquery
Microsoft SQL Server Valid values:agent
,error
MySQL Valid values:audit
,error
,general
,slowquery
Oracle Valid values:alert
,audit
,listener
,trace
,oemagent
PostgreSQL Valid values:postgresql
,upgrade
- Enable
IAMDatabase boolAuthentication - A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see IAM Database Authentication for MariaDB, MySQL, and PostgreSQL in the Amazon RDS User Guide. Amazon Aurora Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
- Enable
Performance boolInsights - Specifies whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom DB instances.
- Endpoint
Rds
Db Instance Endpoint - The connection endpoint for the DB instance. The endpoint might not be shown for instances with the status of
creating
. This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions: +CreateDBInstance
+DescribeDBInstances
+DeleteDBInstance
For the data structure that represents Amazon Aurora DB cluster endpoints, seeDBClusterEndpoint
. - Engine string
- The name of the database engine to use for this DB instance. Not every database engine is available in every AWS Region. This property is required when creating a DB instance. You can change the architecture of an Oracle database from the non-container database (CDB) architecture to the CDB architecture by updating the
Engine
value in your templates fromoracle-ee
ororacle-ee-cdb
tooracle-se2-cdb
. Converting to the CDB architecture requires an interruption. Valid Values: +aurora-mysql
(for Aurora MySQL DB instances) +aurora-postgresql
(for Aurora PostgreSQL DB instances) +custom-oracle-ee
(for RDS Custom for Oracle DB instances) +custom-oracle-ee-cdb
(for RDS Custom for Oracle DB instances) +custom-sqlserver-ee
(for RDS Custom for SQL Server DB instances) +custom-sqlserver-se
(for RDS Custom for SQL Server DB instances) +custom-sqlserver-web
(for RDS Custom for SQL Server DB instances) +db2-ae
+db2-se
+mariadb
+mysql
+oracle-ee
+oracle-ee-cdb
+oracle-se2
+oracle-se2-cdb
+postgres
+sqlserver-ee
+sqlserver-se
+sqlserver-ex
+sqlserver-web
- Engine
Version string - The version number of the database engine to use. For a list of valid engine versions, use the
DescribeDBEngineVersions
action. The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region. Amazon Aurora Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. Db2 See Amazon RDS for Db2 in the Amazon RDS User Guide. MariaDB See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide. Microsoft SQL Server See Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide. MySQL See MySQL on Amazon RDS Versions in the Amazon RDS User Guide. Oracle See Oracle Database Engine Release Notes in the Amazon RDS User Guide. PostgreSQL See Supported PostgreSQL Database Versions in the Amazon RDS User Guide. - Iops int
- The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide. If you specify
io1
for theStorageType
property, then you must also specify theIops
property. Constraints: + For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance. + For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance. - Kms
Key stringId - The ARN of the AWS KMS key that's used to encrypt the DB instance, such as
arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef
. If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default KMS key. If you specify this property, you must set the StorageEncrypted property to true. If you specify theSourceDBInstanceIdentifier
property, the value is inherited from the source DB instance if the read replica is created in the same region. If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region. If you specify theSnapshotIdentifier
property, theStorageEncrypted
property value is inherited from the snapshot, and if the DB instance is encrypted, the specifiedKmsKeyId
property is used. If you specifyDBSecurityGroups
, AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see Using Amazon RDS with Amazon VPC in the Amazon RDS User Guide. Amazon Aurora Not applicable. The KMS key identifier is managed by the DB cluster. - License
Model string - License model information for this DB instance. Valid Values: + Aurora MySQL -
general-public-license
+ Aurora PostgreSQL -postgresql-license
+ RDS for Db2 -bring-your-own-license
. For more information about RDS for Db2 licensing, see in the Amazon RDS User Guide. + 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
orlicense-included
+ RDS for PostgreSQL -postgresql-license
If you've specifiedDBSecurityGroups
and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability. - Manage
Master boolUser Password - Specifies whether to manage the master user password with AWS Secrets Manager. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide. Constraints: + Can't manage the master user password with AWS Secrets Manager if
MasterUserPassword
is specified. - Master
User stringPassword - The password for the master user. The password can include any printable ASCII character except '/', ''', or '@'. Amazon Aurora Not applicable. The password for the master user is managed by the DB cluster. RDS for Db2 Must contain from 8 to 255 characters. RDS for MariaDB Constraints: Must contain from 8 to 41 characters. RDS for Microsoft SQL Server Constraints: Must contain from 8 to 128 characters. RDS for MySQL Constraints: Must contain from 8 to 41 characters. RDS for Oracle Constraints: Must contain from 8 to 30 characters. RDS for PostgreSQL Constraints: Must contain from 8 to 128 characters.
- Master
User MasterSecret User Secret - The secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide. The
MasterUserSecret
return value specifies the secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide and Password management with Secrets Manager in the Amazon Aurora User Guide. - Master
Username string - The master user name for the DB instance. If you specify the
SourceDBInstanceIdentifier
orDBSnapshotIdentifier
property, don't specify this property. The value is inherited from the source DB instance or snapshot. When migrating a self-managed Db2 database, we recommend that you use the same master username as your self-managed Db2 instance name. Amazon Aurora Not applicable. The name for the master user is managed by the DB cluster. RDS for Db2 Constraints: + Must be 1 to 16 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for MariaDB Constraints: + Must be 1 to 16 letters or numbers. + Can't be a reserved word for the chosen database engine. RDS for Microsoft SQL Server Constraints: + Must be 1 to 128 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for MySQL Constraints: + Must be 1 to 16 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for Oracle Constraints: + Must be 1 to 30 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for PostgreSQL Constraints: + Must be 1 to 63 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. - Max
Allocated intStorage - The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide. This setting doesn't apply to the following DB instances: + Amazon Aurora (Storage is managed by the DB cluster.) + RDS Custom
- Monitoring
Interval int - The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0. If
MonitoringRoleArn
is specified, then you must setMonitoringInterval
to a value other than 0. This setting doesn't apply to RDS Custom. 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 Amazon CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide. IfMonitoringInterval
is set to a value other than0
, then you must supply aMonitoringRoleArn
value. This setting doesn't apply to RDS Custom DB instances. - Multi
AZ bool - Specifies whether the database instance is a Multi-AZ DB instance deployment. You can't set the
AvailabilityZone
parameter if theMultiAZ
parameter is set to true. For more information, see Multi-AZ deployments for high availability in the Amazon RDS User Guide. Amazon Aurora Not applicable. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require theMultiAZ
option to be set. - Nchar
Character stringSet Name - The name of the NCHAR character set for the Oracle DB instance. This setting doesn't apply to RDS Custom DB instances.
- Network
Type string - The network type of the DB instance. Valid values: +
IPV4
+DUAL
The network type is determined by theDBSubnetGroup
specified for the DB instance. ADBSubnetGroup
can support only the IPv4 protocol or the IPv4 and IPv6 protocols (DUAL
). For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide. - Option
Group stringName - Indicates that the DB instance should be associated with the specified option group. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance.
- Performance
Insights stringKMSKey Id - The AWS KMS key identifier for encryption of Performance Insights data. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for
PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region. For information about enabling Performance Insights, see EnablePerformanceInsights. - Performance
Insights intRetention Period - The number of days to retain Performance Insights data. This setting doesn't apply to RDS Custom DB instances. Valid Values: +
7
+ month * 31, where month is a number of months from 1-23. Examples:93
(3 months * 31),341
(11 months * 31),589
(19 months * 31) +731
Default:7
days If you specify a retention period that isn't valid, such as94
, Amazon RDS returns an error. - Port string
- The port number on which the database accepts connections. Amazon Aurora Not applicable. The port number is managed by the DB cluster. Db2 Default value:
50000
- Preferred
Backup stringWindow - The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod
parameter. For more information, see Backup Window in the Amazon RDS User Guide. Constraints: + Must be in the formathh24:mi-hh24:mi
. + Must be in Universal Coordinated Time (UTC). + Must not conflict with the preferred maintenance window. + Must be at least 30 minutes. Amazon Aurora Not applicable. The daily time range for creating automated backups is managed by the DB cluster. - Preferred
Maintenance stringWindow - The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format:
ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window in the Amazon RDS User Guide. This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately. Constraints: Minimum 30-minute window. - Processor
Features []ProcessorFeature - The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
- Promotion
Tier int - The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide. This setting doesn't apply to RDS Custom DB instances. Default:
1
Valid Values:0 - 15
- Publicly
Accessible bool - Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address. The default behavior value depends on your VPC setup and the database subnet group. For more information, see the
PubliclyAccessible
parameter in the CreateDBInstance in the Amazon RDS API Reference. - Replica
Mode string - The open mode of an Oracle read replica. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide. This setting is only supported in RDS for Oracle. Default:
open-read-only
Valid Values:open-read-only
ormounted
- Restore
Time string - The date and time to restore from. Constraints: + Must be a time in Universal Coordinated Time (UTC) format. + Must be before the latest restorable time for the DB instance. + Can't be specified if the
UseLatestRestorableTime
parameter is enabled. Example:2009-09-07T23:45:00Z
- Source
DBCluster stringIdentifier - The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas. Constraints: + Must be the identifier of an existing Multi-AZ DB cluster. + Can't be specified if the
SourceDBInstanceIdentifier
parameter is also specified. + The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0. + The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported. - Source
DBInstance stringAutomated Backups Arn - The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example,
arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE
. This setting doesn't apply to RDS Custom. - Source
DBInstance stringIdentifier - If you want to create a read replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of read replicas. For more information, see Working with Read Replicas in the Amazon RDS User Guide. For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide. The
SourceDBInstanceIdentifier
property determines whether a DB instance is a read replica. If you remove theSourceDBInstanceIdentifier
property from your template and then update your stack, AWS CloudFormation promotes the Read Replica to a standalone DB instance. + If you specify a source DB instance that uses VPC security groups, we recommend that you specify theVPCSecurityGroups
property. If you don't specify the property, the read replica inherits the value of theVPCSecurityGroups
property from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica'sVPCSecurityGroups
property to the default value because it's not defined in the stack's template. This change might cause unexpected issues. + Read replicas don't support deletion policies. AWS CloudFormation ignores any deletion policy that's associated with a read replica. + If you specifySourceDBInstanceIdentifier
, don't specify theDBSnapshotIdentifier
property. You can't create a read replica from a snapshot. + Don't set theBackupRetentionPeriod
,DBName
,MasterUsername
,MasterUserPassword
, andPreferredBackupWindow
properties. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas. + If the source DB instance is in a different region than the read replica, specify the source region inSourceRegion
, and specify an ARN for a valid DB instance inSourceDBInstanceIdentifier
. For more information, see Constructing a Amazon RDS Amazon Resource Name (ARN) in the Amazon RDS User Guide. + For DB instances in Amazon Aurora clusters, don't specify this property. Amazon RDS automatically assigns writer and reader DB instances. - Source
Dbi stringResource Id - The resource ID of the source DB instance from which to restore.
- Source
Region string - The ID of the region that contains the source DB instance for the read replica.
- Storage
Encrypted bool - A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. If you specify the
KmsKeyId
property, then you must enable encryption. If you specify theSourceDBInstanceIdentifier
property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specifiedKmsKeyId
property is used. If you specify theDBSnapshotIdentifier
and the specified snapshot is encrypted, don't specify this property. The value is inherited from the snapshot, and the specifiedKmsKeyId
property is used. If you specify theDBSnapshotIdentifier
and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB instance is encrypted. Specify theKmsKeyId
property for the KMS key to use for encryption. If you don't want the restored DB instance to be encrypted, then don't set this property or set it tofalse
. Amazon Aurora Not applicable. The encryption for DB instances is managed by the DB cluster. - Storage
Throughput int - Specifies the storage throughput value for the DB instance. This setting applies only to the
gp3
storage type. This setting doesn't apply to RDS Custom or Amazon Aurora. - Storage
Type string - The storage type to associate with the DB instance. If you specify
io1
,io2
, orgp3
, you must also include a value for theIops
parameter. This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster. Valid Values:gp2 | gp3 | io1 | io2 | standard
Default:io1
, if theIops
parameter is specified. Otherwise,gp2
. - []Tag
- An optional array of key-value pairs to apply to this DB instance.
- Tde
Credential stringArn - Property tdeCredentialArn
- Tde
Credential stringPassword - Property tdeCredentialPassword
- Timezone string
- The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.
- Use
Default boolProcessor Features - Specifies whether the DB instance class of the DB instance uses its default processor features. This setting doesn't apply to RDS Custom DB instances.
- Use
Latest boolRestorable Time - Specifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time. Constraints: + Can't be specified if the
RestoreTime
parameter is provided. - Vpc
Security []stringGroups - A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to AWS::EC2::SecurityGroup resources created in the template. If you plan to update the resource, don't specify VPC security groups in a shared VPC. If you set
VPCSecurityGroups
, you must not set DBSecurityGroups, and vice versa. You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind: + You can't revert to using an RDS security group after you establish a VPC security group membership. + When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group. + To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the DBSecurityGroups property. To avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template. Amazon Aurora Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
- allocated
Storage String - The amount of storage in gibibytes (GiB) to be initially allocated for the database instance. If any value is set in the
Iops
parameter,AllocatedStorage
must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase theIops
value (in 1,000 IOPS increments), then you must also increase theAllocatedStorage
value (in 100-GiB increments). Amazon Aurora Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume. Db2 Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000. + Provisioned IOPS storage (io1): Must be an integer from 100 to 64000. MySQL Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. MariaDB Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. PostgreSQL Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. Oracle Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 10 to 3072. SQL Server Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): + Enterprise and Standard editions: Must be an integer from 20 to 16384. + Web and Express editions: Must be an integer from 20 to 16384. + Provisioned IOPS storage (io1): + Enterprise and Standard editions: Must be an integer from 20 to 16384. + Web and Express editions: Must be an integer from 20 to 16384. + Magnetic storage (standard): + Enterprise and Standard editions: Must be an integer from 20 to 1024. + Web and Express editions: Must be an integer from 20 to 1024. - allow
Major BooleanVersion Upgrade - A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Constraints: Major version upgrades must be allowed when specifying a value for the
EngineVersion
parameter that is a different major version than the DB instance's current version. - associated
Roles List<DBInstanceRole> - The IAMlong (IAM) roles associated with the DB instance. Amazon Aurora Not applicable. The associated roles are managed by the DB cluster.
- auto
Minor BooleanVersion Upgrade - A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.
- automatic
Backup StringReplication Kms Key Id - Property automaticBackupReplicationKmsKeyId
- automatic
Backup StringReplication Region - The destination region for the backup replication of the DB instance. For more info, see Replicating automated backups to another Region in the Amazon RDS User Guide.
- availability
Zone String - The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see Regions and Availability Zones. For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one. Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region. Constraints: + The
AvailabilityZone
parameter can't be specified if the DB instance is a Multi-AZ deployment. + The specified Availability Zone must be in the same AWS-Region as the current endpoint. Example:us-east-1d
- backup
Retention IntegerPeriod - The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Amazon Aurora Not applicable. The retention period for automated backups is managed by the DB cluster. Default: 1 Constraints: + Must be a value from 0 to 35 + Can't be set to 0 if the DB instance is a source to read replicas
- ca
Certificate StringIdentifier - The identifier of the CA certificate for this DB instance. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- certificate
Details CertificateDetails - The details of the DB instance's server certificate. Returns the details of the DB instance’s server certificate. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- certificate
Rotation BooleanRestart - Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate. By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. Set this parameter only if you are not using SSL/TLS to connect to the DB instance. If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate: + For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide. + For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide. This setting doesn't apply to RDS Custom DB instances.
- character
Set StringName - For supported engines, indicates that the DB instance should be associated with the specified character set. Amazon Aurora Not applicable. The character set is managed by the DB cluster. For more information, see AWS::RDS::DBCluster.
- Boolean
- Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
- custom
IAMInstance StringProfile - The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. This setting is required for RDS Custom. Constraints: + The profile must exist in your account. + The profile must have an IAM role that Amazon EC2 has permissions to assume. + The instance profile name and the associated IAM role name must start with the prefix
AWSRDSCustom
. For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide. - db
Cluster StringIdentifier - The identifier of the DB cluster that the instance will belong to.
- db
Cluster StringSnapshot Identifier - The identifier for the Multi-AZ DB cluster snapshot to restore from. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide. Constraints: + Must match the identifier of an existing Multi-AZ DB cluster snapshot. + Can't be specified when
DBSnapshotIdentifier
is specified. + Must be specified whenDBSnapshotIdentifier
isn't specified. + If you are restoring from a shared manual Multi-AZ DB cluster snapshot, theDBClusterSnapshotIdentifier
must be the ARN of the shared snapshot. + Can't be the identifier of an Aurora DB cluster snapshot. - db
Instance StringArn - Property dbInstanceArn
- db
Instance StringClass - The compute and memory capacity of the DB instance, for example
db.m5.large
. Not all DB instance classes are available in all AWS-Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB instance classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide. - db
Instance StringIdentifier - A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see Name Type. For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
- db
Name String - The meaning of this parameter differs according to the database engine you use. If you specify the
DBSnapshotIdentifier
property, this property only applies to RDS for Oracle. Amazon Aurora Not applicable. The database name is managed by the DB cluster. Db2 The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. Constraints: + Must contain 1 to 64 letters or numbers. + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + Can't be a word reserved by the specified database engine. MySQL 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. Constraints: + Must contain 1 to 64 letters or numbers. + Can't be a word reserved by the specified database engine MariaDB 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. Constraints: + Must contain 1 to 64 letters or numbers. + Can't be a word reserved by the specified database engine PostgreSQL The name of the database to create when the DB instance is created. If this parameter is not specified, the defaultpostgres
database is created in the DB instance. Constraints: + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + Must contain 1 to 63 characters. + Can't be a word reserved by the specified database engine Oracle The Oracle System ID (SID) of the created DB instance. If you specifynull
, the default valueORCL
is used. You can't specify the string NULL, or any other reserved word, forDBName
. Default:ORCL
Constraints: + Can't be longer than 8 characters SQL Server Not applicable. Must be null. - db
Parameter StringGroup Name - The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template. To list all of the available DB parameter group names, use the following command:
aws rds describe-db-parameter-groups --query 'DBParameterGroups[].DBParameterGroupName' --output text
If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot. If you don't specify a value forDBParameterGroupName
property, the default DB parameter group for the specified engine and engine version is used. - db
Security List<String>Groups - A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template. If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups. If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations: +
AllocatedStorage
+AutoMinorVersionUpgrade
+AvailabilityZone
+BackupRetentionPeriod
+CharacterSetName
+DBInstanceClass
+DBName
+DBParameterGroupName
+DBSecurityGroups
+DBSubnetGroupName
+Engine
+EngineVersion
+Iops
+LicenseModel
+MasterUsername
+MasterUserPassword
+MultiAZ
+OptionGroupName
+PreferredBackupWindow
+PreferredMaintenanceWindow
All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such asStorageType
,StorageEncrypted
, orKmsKeyId
. If you're already using theDBSecurityGroups
property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance. - db
Snapshot StringIdentifier - The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot. By specifying this property, you can create a DB instance from the specified DB snapshot. If the
DBSnapshotIdentifier
property is an empty string or theAWS::RDS::DBInstance
declaration has noDBSnapshotIdentifier
property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack. Some DB instance properties aren't valid when you restore from a snapshot, such as theMasterUsername
andMasterUserPassword
properties. For information about the properties that you can specify, see theRestoreDBInstanceFromDBSnapshot
action in the Amazon RDS API Reference. After you restore a DB instance with aDBSnapshotIdentifier
property, you must specify the sameDBSnapshotIdentifier
property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify theDBSnapshotIdentifier
property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specifiedDBSnapshotIdentifier
property, and the original DB instance is deleted. If you specify theDBSnapshotIdentifier
property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties: +CharacterSetName
+DBClusterIdentifier
+DBName
+DeleteAutomatedBackups
+EnablePerformanceInsights
+KmsKeyId
+MasterUsername
+MasterUserPassword
+PerformanceInsightsKMSKeyId
+PerformanceInsightsRetentionPeriod
+PromotionTier
+SourceDBInstanceIdentifier
+SourceRegion
+StorageEncrypted
(for an encrypted snapshot) +Timezone
Amazon Aurora Not applicable. Snapshot restore is managed by the DB cluster. - db
Subnet StringGroup Name - A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC. If there's no DB subnet group, then the DB instance isn't a VPC DB instance. For more information about using Amazon RDS in a VPC, see Using Amazon RDS with Amazon Virtual Private Cloud (VPC) in the Amazon RDS User Guide. Amazon Aurora Not applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
- db
System StringId - The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term 'Oracle database instance' refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to
RDSCDB
. The Oracle SID is also the name of your CDB. - dbi
Resource StringId - Property dbiResourceId
- dedicated
Log BooleanVolume - Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
- delete
Automated BooleanBackups - A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted. Amazon Aurora Not applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted.
- deletion
Protection Boolean - A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance. Amazon Aurora Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see
CreateDBCluster
. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster. - domain String
- The Active Directory directory ID to create the DB instance in. Currently, only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see Kerberos Authentication in the Amazon RDS User Guide.
- domain
Auth StringSecret Arn - The ARN for the Secrets Manager secret with the credentials for the user joining the domain. Example:
arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
- domain
Dns List<String>Ips - The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers. Constraints: + 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. Example:
123.124.125.126,234.235.236.237
- domain
Fqdn String - The fully qualified domain name (FQDN) of an Active Directory domain. Constraints: + Can't be longer than 64 characters. Example:
mymanagedADtest.mymanagedAD.mydomain
- domain
IAMRole StringName - The name of the IAM role to use when making API calls to the Directory Service. This setting doesn't apply to the following DB instances: + Amazon Aurora (The domain is managed by the DB cluster.) + RDS Custom
- domain
Ou String - The Active Directory organizational unit for your DB instance to join. Constraints: + Must be in the distinguished name format. + Can't be longer than 64 characters. Example:
OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
- enable
Cloudwatch List<String>Logs Exports - The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service User Guide. Amazon Aurora Not applicable. CloudWatch Logs exports are managed by the DB cluster. Db2 Valid values:
diag.log
,notify.log
MariaDB Valid values:audit
,error
,general
,slowquery
Microsoft SQL Server Valid values:agent
,error
MySQL Valid values:audit
,error
,general
,slowquery
Oracle Valid values:alert
,audit
,listener
,trace
,oemagent
PostgreSQL Valid values:postgresql
,upgrade
- enable
IAMDatabase BooleanAuthentication - A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see IAM Database Authentication for MariaDB, MySQL, and PostgreSQL in the Amazon RDS User Guide. Amazon Aurora Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
- enable
Performance BooleanInsights - Specifies whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom DB instances.
- endpoint
Rds
Db Instance Endpoint - The connection endpoint for the DB instance. The endpoint might not be shown for instances with the status of
creating
. This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions: +CreateDBInstance
+DescribeDBInstances
+DeleteDBInstance
For the data structure that represents Amazon Aurora DB cluster endpoints, seeDBClusterEndpoint
. - engine String
- The name of the database engine to use for this DB instance. Not every database engine is available in every AWS Region. This property is required when creating a DB instance. You can change the architecture of an Oracle database from the non-container database (CDB) architecture to the CDB architecture by updating the
Engine
value in your templates fromoracle-ee
ororacle-ee-cdb
tooracle-se2-cdb
. Converting to the CDB architecture requires an interruption. Valid Values: +aurora-mysql
(for Aurora MySQL DB instances) +aurora-postgresql
(for Aurora PostgreSQL DB instances) +custom-oracle-ee
(for RDS Custom for Oracle DB instances) +custom-oracle-ee-cdb
(for RDS Custom for Oracle DB instances) +custom-sqlserver-ee
(for RDS Custom for SQL Server DB instances) +custom-sqlserver-se
(for RDS Custom for SQL Server DB instances) +custom-sqlserver-web
(for RDS Custom for SQL Server DB instances) +db2-ae
+db2-se
+mariadb
+mysql
+oracle-ee
+oracle-ee-cdb
+oracle-se2
+oracle-se2-cdb
+postgres
+sqlserver-ee
+sqlserver-se
+sqlserver-ex
+sqlserver-web
- engine
Version String - The version number of the database engine to use. For a list of valid engine versions, use the
DescribeDBEngineVersions
action. The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region. Amazon Aurora Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. Db2 See Amazon RDS for Db2 in the Amazon RDS User Guide. MariaDB See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide. Microsoft SQL Server See Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide. MySQL See MySQL on Amazon RDS Versions in the Amazon RDS User Guide. Oracle See Oracle Database Engine Release Notes in the Amazon RDS User Guide. PostgreSQL See Supported PostgreSQL Database Versions in the Amazon RDS User Guide. - iops Integer
- The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide. If you specify
io1
for theStorageType
property, then you must also specify theIops
property. Constraints: + For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance. + For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance. - kms
Key StringId - The ARN of the AWS KMS key that's used to encrypt the DB instance, such as
arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef
. If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default KMS key. If you specify this property, you must set the StorageEncrypted property to true. If you specify theSourceDBInstanceIdentifier
property, the value is inherited from the source DB instance if the read replica is created in the same region. If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region. If you specify theSnapshotIdentifier
property, theStorageEncrypted
property value is inherited from the snapshot, and if the DB instance is encrypted, the specifiedKmsKeyId
property is used. If you specifyDBSecurityGroups
, AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see Using Amazon RDS with Amazon VPC in the Amazon RDS User Guide. Amazon Aurora Not applicable. The KMS key identifier is managed by the DB cluster. - license
Model String - License model information for this DB instance. Valid Values: + Aurora MySQL -
general-public-license
+ Aurora PostgreSQL -postgresql-license
+ RDS for Db2 -bring-your-own-license
. For more information about RDS for Db2 licensing, see in the Amazon RDS User Guide. + 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
orlicense-included
+ RDS for PostgreSQL -postgresql-license
If you've specifiedDBSecurityGroups
and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability. - manage
Master BooleanUser Password - Specifies whether to manage the master user password with AWS Secrets Manager. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide. Constraints: + Can't manage the master user password with AWS Secrets Manager if
MasterUserPassword
is specified. - master
User StringPassword - The password for the master user. The password can include any printable ASCII character except '/', ''', or '@'. Amazon Aurora Not applicable. The password for the master user is managed by the DB cluster. RDS for Db2 Must contain from 8 to 255 characters. RDS for MariaDB Constraints: Must contain from 8 to 41 characters. RDS for Microsoft SQL Server Constraints: Must contain from 8 to 128 characters. RDS for MySQL Constraints: Must contain from 8 to 41 characters. RDS for Oracle Constraints: Must contain from 8 to 30 characters. RDS for PostgreSQL Constraints: Must contain from 8 to 128 characters.
- master
User MasterSecret User Secret - The secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide. The
MasterUserSecret
return value specifies the secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide and Password management with Secrets Manager in the Amazon Aurora User Guide. - master
Username String - The master user name for the DB instance. If you specify the
SourceDBInstanceIdentifier
orDBSnapshotIdentifier
property, don't specify this property. The value is inherited from the source DB instance or snapshot. When migrating a self-managed Db2 database, we recommend that you use the same master username as your self-managed Db2 instance name. Amazon Aurora Not applicable. The name for the master user is managed by the DB cluster. RDS for Db2 Constraints: + Must be 1 to 16 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for MariaDB Constraints: + Must be 1 to 16 letters or numbers. + Can't be a reserved word for the chosen database engine. RDS for Microsoft SQL Server Constraints: + Must be 1 to 128 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for MySQL Constraints: + Must be 1 to 16 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for Oracle Constraints: + Must be 1 to 30 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for PostgreSQL Constraints: + Must be 1 to 63 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. - max
Allocated IntegerStorage - The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide. This setting doesn't apply to the following DB instances: + Amazon Aurora (Storage is managed by the DB cluster.) + RDS Custom
- monitoring
Interval Integer - The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0. If
MonitoringRoleArn
is specified, then you must setMonitoringInterval
to a value other than 0. This setting doesn't apply to RDS Custom. 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 Amazon CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide. IfMonitoringInterval
is set to a value other than0
, then you must supply aMonitoringRoleArn
value. This setting doesn't apply to RDS Custom DB instances. - multi
AZ Boolean - Specifies whether the database instance is a Multi-AZ DB instance deployment. You can't set the
AvailabilityZone
parameter if theMultiAZ
parameter is set to true. For more information, see Multi-AZ deployments for high availability in the Amazon RDS User Guide. Amazon Aurora Not applicable. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require theMultiAZ
option to be set. - nchar
Character StringSet Name - The name of the NCHAR character set for the Oracle DB instance. This setting doesn't apply to RDS Custom DB instances.
- network
Type String - The network type of the DB instance. Valid values: +
IPV4
+DUAL
The network type is determined by theDBSubnetGroup
specified for the DB instance. ADBSubnetGroup
can support only the IPv4 protocol or the IPv4 and IPv6 protocols (DUAL
). For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide. - option
Group StringName - Indicates that the DB instance should be associated with the specified option group. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance.
- performance
Insights StringKMSKey Id - The AWS KMS key identifier for encryption of Performance Insights data. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for
PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region. For information about enabling Performance Insights, see EnablePerformanceInsights. - performance
Insights IntegerRetention Period - The number of days to retain Performance Insights data. This setting doesn't apply to RDS Custom DB instances. Valid Values: +
7
+ month * 31, where month is a number of months from 1-23. Examples:93
(3 months * 31),341
(11 months * 31),589
(19 months * 31) +731
Default:7
days If you specify a retention period that isn't valid, such as94
, Amazon RDS returns an error. - port String
- The port number on which the database accepts connections. Amazon Aurora Not applicable. The port number is managed by the DB cluster. Db2 Default value:
50000
- preferred
Backup StringWindow - The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod
parameter. For more information, see Backup Window in the Amazon RDS User Guide. Constraints: + Must be in the formathh24:mi-hh24:mi
. + Must be in Universal Coordinated Time (UTC). + Must not conflict with the preferred maintenance window. + Must be at least 30 minutes. Amazon Aurora Not applicable. The daily time range for creating automated backups is managed by the DB cluster. - preferred
Maintenance StringWindow - The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format:
ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window in the Amazon RDS User Guide. This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately. Constraints: Minimum 30-minute window. - processor
Features List<ProcessorFeature> - The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
- promotion
Tier Integer - The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide. This setting doesn't apply to RDS Custom DB instances. Default:
1
Valid Values:0 - 15
- publicly
Accessible Boolean - Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address. The default behavior value depends on your VPC setup and the database subnet group. For more information, see the
PubliclyAccessible
parameter in the CreateDBInstance in the Amazon RDS API Reference. - replica
Mode String - The open mode of an Oracle read replica. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide. This setting is only supported in RDS for Oracle. Default:
open-read-only
Valid Values:open-read-only
ormounted
- restore
Time String - The date and time to restore from. Constraints: + Must be a time in Universal Coordinated Time (UTC) format. + Must be before the latest restorable time for the DB instance. + Can't be specified if the
UseLatestRestorableTime
parameter is enabled. Example:2009-09-07T23:45:00Z
- source
DBCluster StringIdentifier - The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas. Constraints: + Must be the identifier of an existing Multi-AZ DB cluster. + Can't be specified if the
SourceDBInstanceIdentifier
parameter is also specified. + The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0. + The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported. - source
DBInstance StringAutomated Backups Arn - The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example,
arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE
. This setting doesn't apply to RDS Custom. - source
DBInstance StringIdentifier - If you want to create a read replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of read replicas. For more information, see Working with Read Replicas in the Amazon RDS User Guide. For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide. The
SourceDBInstanceIdentifier
property determines whether a DB instance is a read replica. If you remove theSourceDBInstanceIdentifier
property from your template and then update your stack, AWS CloudFormation promotes the Read Replica to a standalone DB instance. + If you specify a source DB instance that uses VPC security groups, we recommend that you specify theVPCSecurityGroups
property. If you don't specify the property, the read replica inherits the value of theVPCSecurityGroups
property from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica'sVPCSecurityGroups
property to the default value because it's not defined in the stack's template. This change might cause unexpected issues. + Read replicas don't support deletion policies. AWS CloudFormation ignores any deletion policy that's associated with a read replica. + If you specifySourceDBInstanceIdentifier
, don't specify theDBSnapshotIdentifier
property. You can't create a read replica from a snapshot. + Don't set theBackupRetentionPeriod
,DBName
,MasterUsername
,MasterUserPassword
, andPreferredBackupWindow
properties. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas. + If the source DB instance is in a different region than the read replica, specify the source region inSourceRegion
, and specify an ARN for a valid DB instance inSourceDBInstanceIdentifier
. For more information, see Constructing a Amazon RDS Amazon Resource Name (ARN) in the Amazon RDS User Guide. + For DB instances in Amazon Aurora clusters, don't specify this property. Amazon RDS automatically assigns writer and reader DB instances. - source
Dbi StringResource Id - The resource ID of the source DB instance from which to restore.
- source
Region String - The ID of the region that contains the source DB instance for the read replica.
- storage
Encrypted Boolean - A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. If you specify the
KmsKeyId
property, then you must enable encryption. If you specify theSourceDBInstanceIdentifier
property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specifiedKmsKeyId
property is used. If you specify theDBSnapshotIdentifier
and the specified snapshot is encrypted, don't specify this property. The value is inherited from the snapshot, and the specifiedKmsKeyId
property is used. If you specify theDBSnapshotIdentifier
and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB instance is encrypted. Specify theKmsKeyId
property for the KMS key to use for encryption. If you don't want the restored DB instance to be encrypted, then don't set this property or set it tofalse
. Amazon Aurora Not applicable. The encryption for DB instances is managed by the DB cluster. - storage
Throughput Integer - Specifies the storage throughput value for the DB instance. This setting applies only to the
gp3
storage type. This setting doesn't apply to RDS Custom or Amazon Aurora. - storage
Type String - The storage type to associate with the DB instance. If you specify
io1
,io2
, orgp3
, you must also include a value for theIops
parameter. This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster. Valid Values:gp2 | gp3 | io1 | io2 | standard
Default:io1
, if theIops
parameter is specified. Otherwise,gp2
. - List<Tag>
- An optional array of key-value pairs to apply to this DB instance.
- tde
Credential StringArn - Property tdeCredentialArn
- tde
Credential StringPassword - Property tdeCredentialPassword
- timezone String
- The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.
- use
Default BooleanProcessor Features - Specifies whether the DB instance class of the DB instance uses its default processor features. This setting doesn't apply to RDS Custom DB instances.
- use
Latest BooleanRestorable Time - Specifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time. Constraints: + Can't be specified if the
RestoreTime
parameter is provided. - vpc
Security List<String>Groups - A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to AWS::EC2::SecurityGroup resources created in the template. If you plan to update the resource, don't specify VPC security groups in a shared VPC. If you set
VPCSecurityGroups
, you must not set DBSecurityGroups, and vice versa. You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind: + You can't revert to using an RDS security group after you establish a VPC security group membership. + When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group. + To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the DBSecurityGroups property. To avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template. Amazon Aurora Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
- allocated
Storage string - The amount of storage in gibibytes (GiB) to be initially allocated for the database instance. If any value is set in the
Iops
parameter,AllocatedStorage
must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase theIops
value (in 1,000 IOPS increments), then you must also increase theAllocatedStorage
value (in 100-GiB increments). Amazon Aurora Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume. Db2 Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000. + Provisioned IOPS storage (io1): Must be an integer from 100 to 64000. MySQL Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. MariaDB Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. PostgreSQL Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. Oracle Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 10 to 3072. SQL Server Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): + Enterprise and Standard editions: Must be an integer from 20 to 16384. + Web and Express editions: Must be an integer from 20 to 16384. + Provisioned IOPS storage (io1): + Enterprise and Standard editions: Must be an integer from 20 to 16384. + Web and Express editions: Must be an integer from 20 to 16384. + Magnetic storage (standard): + Enterprise and Standard editions: Must be an integer from 20 to 1024. + Web and Express editions: Must be an integer from 20 to 1024. - allow
Major booleanVersion Upgrade - A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Constraints: Major version upgrades must be allowed when specifying a value for the
EngineVersion
parameter that is a different major version than the DB instance's current version. - associated
Roles DBInstanceRole[] - The IAMlong (IAM) roles associated with the DB instance. Amazon Aurora Not applicable. The associated roles are managed by the DB cluster.
- auto
Minor booleanVersion Upgrade - A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.
- automatic
Backup stringReplication Kms Key Id - Property automaticBackupReplicationKmsKeyId
- automatic
Backup stringReplication Region - The destination region for the backup replication of the DB instance. For more info, see Replicating automated backups to another Region in the Amazon RDS User Guide.
- availability
Zone string - The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see Regions and Availability Zones. For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one. Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region. Constraints: + The
AvailabilityZone
parameter can't be specified if the DB instance is a Multi-AZ deployment. + The specified Availability Zone must be in the same AWS-Region as the current endpoint. Example:us-east-1d
- backup
Retention numberPeriod - The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Amazon Aurora Not applicable. The retention period for automated backups is managed by the DB cluster. Default: 1 Constraints: + Must be a value from 0 to 35 + Can't be set to 0 if the DB instance is a source to read replicas
- ca
Certificate stringIdentifier - The identifier of the CA certificate for this DB instance. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- certificate
Details CertificateDetails - The details of the DB instance's server certificate. Returns the details of the DB instance’s server certificate. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- certificate
Rotation booleanRestart - Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate. By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. Set this parameter only if you are not using SSL/TLS to connect to the DB instance. If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate: + For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide. + For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide. This setting doesn't apply to RDS Custom DB instances.
- character
Set stringName - For supported engines, indicates that the DB instance should be associated with the specified character set. Amazon Aurora Not applicable. The character set is managed by the DB cluster. For more information, see AWS::RDS::DBCluster.
- boolean
- Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
- custom
IAMInstance stringProfile - The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. This setting is required for RDS Custom. Constraints: + The profile must exist in your account. + The profile must have an IAM role that Amazon EC2 has permissions to assume. + The instance profile name and the associated IAM role name must start with the prefix
AWSRDSCustom
. For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide. - db
Cluster stringIdentifier - The identifier of the DB cluster that the instance will belong to.
- db
Cluster stringSnapshot Identifier - The identifier for the Multi-AZ DB cluster snapshot to restore from. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide. Constraints: + Must match the identifier of an existing Multi-AZ DB cluster snapshot. + Can't be specified when
DBSnapshotIdentifier
is specified. + Must be specified whenDBSnapshotIdentifier
isn't specified. + If you are restoring from a shared manual Multi-AZ DB cluster snapshot, theDBClusterSnapshotIdentifier
must be the ARN of the shared snapshot. + Can't be the identifier of an Aurora DB cluster snapshot. - db
Instance stringArn - Property dbInstanceArn
- db
Instance stringClass - The compute and memory capacity of the DB instance, for example
db.m5.large
. Not all DB instance classes are available in all AWS-Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB instance classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide. - db
Instance stringIdentifier - A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see Name Type. For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
- db
Name string - The meaning of this parameter differs according to the database engine you use. If you specify the
DBSnapshotIdentifier
property, this property only applies to RDS for Oracle. Amazon Aurora Not applicable. The database name is managed by the DB cluster. Db2 The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. Constraints: + Must contain 1 to 64 letters or numbers. + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + Can't be a word reserved by the specified database engine. MySQL 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. Constraints: + Must contain 1 to 64 letters or numbers. + Can't be a word reserved by the specified database engine MariaDB 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. Constraints: + Must contain 1 to 64 letters or numbers. + Can't be a word reserved by the specified database engine PostgreSQL The name of the database to create when the DB instance is created. If this parameter is not specified, the defaultpostgres
database is created in the DB instance. Constraints: + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + Must contain 1 to 63 characters. + Can't be a word reserved by the specified database engine Oracle The Oracle System ID (SID) of the created DB instance. If you specifynull
, the default valueORCL
is used. You can't specify the string NULL, or any other reserved word, forDBName
. Default:ORCL
Constraints: + Can't be longer than 8 characters SQL Server Not applicable. Must be null. - db
Parameter stringGroup Name - The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template. To list all of the available DB parameter group names, use the following command:
aws rds describe-db-parameter-groups --query 'DBParameterGroups[].DBParameterGroupName' --output text
If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot. If you don't specify a value forDBParameterGroupName
property, the default DB parameter group for the specified engine and engine version is used. - db
Security string[]Groups - A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template. If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups. If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations: +
AllocatedStorage
+AutoMinorVersionUpgrade
+AvailabilityZone
+BackupRetentionPeriod
+CharacterSetName
+DBInstanceClass
+DBName
+DBParameterGroupName
+DBSecurityGroups
+DBSubnetGroupName
+Engine
+EngineVersion
+Iops
+LicenseModel
+MasterUsername
+MasterUserPassword
+MultiAZ
+OptionGroupName
+PreferredBackupWindow
+PreferredMaintenanceWindow
All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such asStorageType
,StorageEncrypted
, orKmsKeyId
. If you're already using theDBSecurityGroups
property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance. - db
Snapshot stringIdentifier - The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot. By specifying this property, you can create a DB instance from the specified DB snapshot. If the
DBSnapshotIdentifier
property is an empty string or theAWS::RDS::DBInstance
declaration has noDBSnapshotIdentifier
property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack. Some DB instance properties aren't valid when you restore from a snapshot, such as theMasterUsername
andMasterUserPassword
properties. For information about the properties that you can specify, see theRestoreDBInstanceFromDBSnapshot
action in the Amazon RDS API Reference. After you restore a DB instance with aDBSnapshotIdentifier
property, you must specify the sameDBSnapshotIdentifier
property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify theDBSnapshotIdentifier
property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specifiedDBSnapshotIdentifier
property, and the original DB instance is deleted. If you specify theDBSnapshotIdentifier
property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties: +CharacterSetName
+DBClusterIdentifier
+DBName
+DeleteAutomatedBackups
+EnablePerformanceInsights
+KmsKeyId
+MasterUsername
+MasterUserPassword
+PerformanceInsightsKMSKeyId
+PerformanceInsightsRetentionPeriod
+PromotionTier
+SourceDBInstanceIdentifier
+SourceRegion
+StorageEncrypted
(for an encrypted snapshot) +Timezone
Amazon Aurora Not applicable. Snapshot restore is managed by the DB cluster. - db
Subnet stringGroup Name - A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC. If there's no DB subnet group, then the DB instance isn't a VPC DB instance. For more information about using Amazon RDS in a VPC, see Using Amazon RDS with Amazon Virtual Private Cloud (VPC) in the Amazon RDS User Guide. Amazon Aurora Not applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
- db
System stringId - The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term 'Oracle database instance' refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to
RDSCDB
. The Oracle SID is also the name of your CDB. - dbi
Resource stringId - Property dbiResourceId
- dedicated
Log booleanVolume - Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
- delete
Automated booleanBackups - A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted. Amazon Aurora Not applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted.
- deletion
Protection boolean - A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance. Amazon Aurora Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see
CreateDBCluster
. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster. - domain string
- The Active Directory directory ID to create the DB instance in. Currently, only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see Kerberos Authentication in the Amazon RDS User Guide.
- domain
Auth stringSecret Arn - The ARN for the Secrets Manager secret with the credentials for the user joining the domain. Example:
arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
- domain
Dns string[]Ips - The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers. Constraints: + 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. Example:
123.124.125.126,234.235.236.237
- domain
Fqdn string - The fully qualified domain name (FQDN) of an Active Directory domain. Constraints: + Can't be longer than 64 characters. Example:
mymanagedADtest.mymanagedAD.mydomain
- domain
IAMRole stringName - The name of the IAM role to use when making API calls to the Directory Service. This setting doesn't apply to the following DB instances: + Amazon Aurora (The domain is managed by the DB cluster.) + RDS Custom
- domain
Ou string - The Active Directory organizational unit for your DB instance to join. Constraints: + Must be in the distinguished name format. + Can't be longer than 64 characters. Example:
OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
- enable
Cloudwatch string[]Logs Exports - The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service User Guide. Amazon Aurora Not applicable. CloudWatch Logs exports are managed by the DB cluster. Db2 Valid values:
diag.log
,notify.log
MariaDB Valid values:audit
,error
,general
,slowquery
Microsoft SQL Server Valid values:agent
,error
MySQL Valid values:audit
,error
,general
,slowquery
Oracle Valid values:alert
,audit
,listener
,trace
,oemagent
PostgreSQL Valid values:postgresql
,upgrade
- enable
IAMDatabase booleanAuthentication - A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see IAM Database Authentication for MariaDB, MySQL, and PostgreSQL in the Amazon RDS User Guide. Amazon Aurora Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
- enable
Performance booleanInsights - Specifies whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom DB instances.
- endpoint
Rds
Db Instance Endpoint - The connection endpoint for the DB instance. The endpoint might not be shown for instances with the status of
creating
. This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions: +CreateDBInstance
+DescribeDBInstances
+DeleteDBInstance
For the data structure that represents Amazon Aurora DB cluster endpoints, seeDBClusterEndpoint
. - engine string
- The name of the database engine to use for this DB instance. Not every database engine is available in every AWS Region. This property is required when creating a DB instance. You can change the architecture of an Oracle database from the non-container database (CDB) architecture to the CDB architecture by updating the
Engine
value in your templates fromoracle-ee
ororacle-ee-cdb
tooracle-se2-cdb
. Converting to the CDB architecture requires an interruption. Valid Values: +aurora-mysql
(for Aurora MySQL DB instances) +aurora-postgresql
(for Aurora PostgreSQL DB instances) +custom-oracle-ee
(for RDS Custom for Oracle DB instances) +custom-oracle-ee-cdb
(for RDS Custom for Oracle DB instances) +custom-sqlserver-ee
(for RDS Custom for SQL Server DB instances) +custom-sqlserver-se
(for RDS Custom for SQL Server DB instances) +custom-sqlserver-web
(for RDS Custom for SQL Server DB instances) +db2-ae
+db2-se
+mariadb
+mysql
+oracle-ee
+oracle-ee-cdb
+oracle-se2
+oracle-se2-cdb
+postgres
+sqlserver-ee
+sqlserver-se
+sqlserver-ex
+sqlserver-web
- engine
Version string - The version number of the database engine to use. For a list of valid engine versions, use the
DescribeDBEngineVersions
action. The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region. Amazon Aurora Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. Db2 See Amazon RDS for Db2 in the Amazon RDS User Guide. MariaDB See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide. Microsoft SQL Server See Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide. MySQL See MySQL on Amazon RDS Versions in the Amazon RDS User Guide. Oracle See Oracle Database Engine Release Notes in the Amazon RDS User Guide. PostgreSQL See Supported PostgreSQL Database Versions in the Amazon RDS User Guide. - iops number
- The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide. If you specify
io1
for theStorageType
property, then you must also specify theIops
property. Constraints: + For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance. + For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance. - kms
Key stringId - The ARN of the AWS KMS key that's used to encrypt the DB instance, such as
arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef
. If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default KMS key. If you specify this property, you must set the StorageEncrypted property to true. If you specify theSourceDBInstanceIdentifier
property, the value is inherited from the source DB instance if the read replica is created in the same region. If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region. If you specify theSnapshotIdentifier
property, theStorageEncrypted
property value is inherited from the snapshot, and if the DB instance is encrypted, the specifiedKmsKeyId
property is used. If you specifyDBSecurityGroups
, AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see Using Amazon RDS with Amazon VPC in the Amazon RDS User Guide. Amazon Aurora Not applicable. The KMS key identifier is managed by the DB cluster. - license
Model string - License model information for this DB instance. Valid Values: + Aurora MySQL -
general-public-license
+ Aurora PostgreSQL -postgresql-license
+ RDS for Db2 -bring-your-own-license
. For more information about RDS for Db2 licensing, see in the Amazon RDS User Guide. + 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
orlicense-included
+ RDS for PostgreSQL -postgresql-license
If you've specifiedDBSecurityGroups
and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability. - manage
Master booleanUser Password - Specifies whether to manage the master user password with AWS Secrets Manager. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide. Constraints: + Can't manage the master user password with AWS Secrets Manager if
MasterUserPassword
is specified. - master
User stringPassword - The password for the master user. The password can include any printable ASCII character except '/', ''', or '@'. Amazon Aurora Not applicable. The password for the master user is managed by the DB cluster. RDS for Db2 Must contain from 8 to 255 characters. RDS for MariaDB Constraints: Must contain from 8 to 41 characters. RDS for Microsoft SQL Server Constraints: Must contain from 8 to 128 characters. RDS for MySQL Constraints: Must contain from 8 to 41 characters. RDS for Oracle Constraints: Must contain from 8 to 30 characters. RDS for PostgreSQL Constraints: Must contain from 8 to 128 characters.
- master
User MasterSecret User Secret - The secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide. The
MasterUserSecret
return value specifies the secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide and Password management with Secrets Manager in the Amazon Aurora User Guide. - master
Username string - The master user name for the DB instance. If you specify the
SourceDBInstanceIdentifier
orDBSnapshotIdentifier
property, don't specify this property. The value is inherited from the source DB instance or snapshot. When migrating a self-managed Db2 database, we recommend that you use the same master username as your self-managed Db2 instance name. Amazon Aurora Not applicable. The name for the master user is managed by the DB cluster. RDS for Db2 Constraints: + Must be 1 to 16 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for MariaDB Constraints: + Must be 1 to 16 letters or numbers. + Can't be a reserved word for the chosen database engine. RDS for Microsoft SQL Server Constraints: + Must be 1 to 128 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for MySQL Constraints: + Must be 1 to 16 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for Oracle Constraints: + Must be 1 to 30 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for PostgreSQL Constraints: + Must be 1 to 63 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. - max
Allocated numberStorage - The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide. This setting doesn't apply to the following DB instances: + Amazon Aurora (Storage is managed by the DB cluster.) + RDS Custom
- monitoring
Interval number - The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0. If
MonitoringRoleArn
is specified, then you must setMonitoringInterval
to a value other than 0. This setting doesn't apply to RDS Custom. 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 Amazon CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide. IfMonitoringInterval
is set to a value other than0
, then you must supply aMonitoringRoleArn
value. This setting doesn't apply to RDS Custom DB instances. - multi
AZ boolean - Specifies whether the database instance is a Multi-AZ DB instance deployment. You can't set the
AvailabilityZone
parameter if theMultiAZ
parameter is set to true. For more information, see Multi-AZ deployments for high availability in the Amazon RDS User Guide. Amazon Aurora Not applicable. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require theMultiAZ
option to be set. - nchar
Character stringSet Name - The name of the NCHAR character set for the Oracle DB instance. This setting doesn't apply to RDS Custom DB instances.
- network
Type string - The network type of the DB instance. Valid values: +
IPV4
+DUAL
The network type is determined by theDBSubnetGroup
specified for the DB instance. ADBSubnetGroup
can support only the IPv4 protocol or the IPv4 and IPv6 protocols (DUAL
). For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide. - option
Group stringName - Indicates that the DB instance should be associated with the specified option group. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance.
- performance
Insights stringKMSKey Id - The AWS KMS key identifier for encryption of Performance Insights data. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for
PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region. For information about enabling Performance Insights, see EnablePerformanceInsights. - performance
Insights numberRetention Period - The number of days to retain Performance Insights data. This setting doesn't apply to RDS Custom DB instances. Valid Values: +
7
+ month * 31, where month is a number of months from 1-23. Examples:93
(3 months * 31),341
(11 months * 31),589
(19 months * 31) +731
Default:7
days If you specify a retention period that isn't valid, such as94
, Amazon RDS returns an error. - port string
- The port number on which the database accepts connections. Amazon Aurora Not applicable. The port number is managed by the DB cluster. Db2 Default value:
50000
- preferred
Backup stringWindow - The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod
parameter. For more information, see Backup Window in the Amazon RDS User Guide. Constraints: + Must be in the formathh24:mi-hh24:mi
. + Must be in Universal Coordinated Time (UTC). + Must not conflict with the preferred maintenance window. + Must be at least 30 minutes. Amazon Aurora Not applicable. The daily time range for creating automated backups is managed by the DB cluster. - preferred
Maintenance stringWindow - The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format:
ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window in the Amazon RDS User Guide. This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately. Constraints: Minimum 30-minute window. - processor
Features ProcessorFeature[] - The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
- promotion
Tier number - The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide. This setting doesn't apply to RDS Custom DB instances. Default:
1
Valid Values:0 - 15
- publicly
Accessible boolean - Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address. The default behavior value depends on your VPC setup and the database subnet group. For more information, see the
PubliclyAccessible
parameter in the CreateDBInstance in the Amazon RDS API Reference. - replica
Mode string - The open mode of an Oracle read replica. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide. This setting is only supported in RDS for Oracle. Default:
open-read-only
Valid Values:open-read-only
ormounted
- restore
Time string - The date and time to restore from. Constraints: + Must be a time in Universal Coordinated Time (UTC) format. + Must be before the latest restorable time for the DB instance. + Can't be specified if the
UseLatestRestorableTime
parameter is enabled. Example:2009-09-07T23:45:00Z
- source
DBCluster stringIdentifier - The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas. Constraints: + Must be the identifier of an existing Multi-AZ DB cluster. + Can't be specified if the
SourceDBInstanceIdentifier
parameter is also specified. + The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0. + The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported. - source
DBInstance stringAutomated Backups Arn - The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example,
arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE
. This setting doesn't apply to RDS Custom. - source
DBInstance stringIdentifier - If you want to create a read replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of read replicas. For more information, see Working with Read Replicas in the Amazon RDS User Guide. For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide. The
SourceDBInstanceIdentifier
property determines whether a DB instance is a read replica. If you remove theSourceDBInstanceIdentifier
property from your template and then update your stack, AWS CloudFormation promotes the Read Replica to a standalone DB instance. + If you specify a source DB instance that uses VPC security groups, we recommend that you specify theVPCSecurityGroups
property. If you don't specify the property, the read replica inherits the value of theVPCSecurityGroups
property from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica'sVPCSecurityGroups
property to the default value because it's not defined in the stack's template. This change might cause unexpected issues. + Read replicas don't support deletion policies. AWS CloudFormation ignores any deletion policy that's associated with a read replica. + If you specifySourceDBInstanceIdentifier
, don't specify theDBSnapshotIdentifier
property. You can't create a read replica from a snapshot. + Don't set theBackupRetentionPeriod
,DBName
,MasterUsername
,MasterUserPassword
, andPreferredBackupWindow
properties. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas. + If the source DB instance is in a different region than the read replica, specify the source region inSourceRegion
, and specify an ARN for a valid DB instance inSourceDBInstanceIdentifier
. For more information, see Constructing a Amazon RDS Amazon Resource Name (ARN) in the Amazon RDS User Guide. + For DB instances in Amazon Aurora clusters, don't specify this property. Amazon RDS automatically assigns writer and reader DB instances. - source
Dbi stringResource Id - The resource ID of the source DB instance from which to restore.
- source
Region string - The ID of the region that contains the source DB instance for the read replica.
- storage
Encrypted boolean - A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. If you specify the
KmsKeyId
property, then you must enable encryption. If you specify theSourceDBInstanceIdentifier
property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specifiedKmsKeyId
property is used. If you specify theDBSnapshotIdentifier
and the specified snapshot is encrypted, don't specify this property. The value is inherited from the snapshot, and the specifiedKmsKeyId
property is used. If you specify theDBSnapshotIdentifier
and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB instance is encrypted. Specify theKmsKeyId
property for the KMS key to use for encryption. If you don't want the restored DB instance to be encrypted, then don't set this property or set it tofalse
. Amazon Aurora Not applicable. The encryption for DB instances is managed by the DB cluster. - storage
Throughput number - Specifies the storage throughput value for the DB instance. This setting applies only to the
gp3
storage type. This setting doesn't apply to RDS Custom or Amazon Aurora. - storage
Type string - The storage type to associate with the DB instance. If you specify
io1
,io2
, orgp3
, you must also include a value for theIops
parameter. This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster. Valid Values:gp2 | gp3 | io1 | io2 | standard
Default:io1
, if theIops
parameter is specified. Otherwise,gp2
. - Tag[]
- An optional array of key-value pairs to apply to this DB instance.
- tde
Credential stringArn - Property tdeCredentialArn
- tde
Credential stringPassword - Property tdeCredentialPassword
- timezone string
- The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.
- use
Default booleanProcessor Features - Specifies whether the DB instance class of the DB instance uses its default processor features. This setting doesn't apply to RDS Custom DB instances.
- use
Latest booleanRestorable Time - Specifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time. Constraints: + Can't be specified if the
RestoreTime
parameter is provided. - vpc
Security string[]Groups - A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to AWS::EC2::SecurityGroup resources created in the template. If you plan to update the resource, don't specify VPC security groups in a shared VPC. If you set
VPCSecurityGroups
, you must not set DBSecurityGroups, and vice versa. You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind: + You can't revert to using an RDS security group after you establish a VPC security group membership. + When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group. + To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the DBSecurityGroups property. To avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template. Amazon Aurora Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
- allocated_
storage str - The amount of storage in gibibytes (GiB) to be initially allocated for the database instance. If any value is set in the
Iops
parameter,AllocatedStorage
must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase theIops
value (in 1,000 IOPS increments), then you must also increase theAllocatedStorage
value (in 100-GiB increments). Amazon Aurora Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume. Db2 Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000. + Provisioned IOPS storage (io1): Must be an integer from 100 to 64000. MySQL Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. MariaDB Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. PostgreSQL Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. Oracle Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 10 to 3072. SQL Server Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): + Enterprise and Standard editions: Must be an integer from 20 to 16384. + Web and Express editions: Must be an integer from 20 to 16384. + Provisioned IOPS storage (io1): + Enterprise and Standard editions: Must be an integer from 20 to 16384. + Web and Express editions: Must be an integer from 20 to 16384. + Magnetic storage (standard): + Enterprise and Standard editions: Must be an integer from 20 to 1024. + Web and Express editions: Must be an integer from 20 to 1024. - allow_
major_ boolversion_ upgrade - A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Constraints: Major version upgrades must be allowed when specifying a value for the
EngineVersion
parameter that is a different major version than the DB instance's current version. - associated_
roles Sequence[DBInstanceRole] - The IAMlong (IAM) roles associated with the DB instance. Amazon Aurora Not applicable. The associated roles are managed by the DB cluster.
- auto_
minor_ boolversion_ upgrade - A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.
- automatic_
backup_ strreplication_ kms_ key_ id - Property automaticBackupReplicationKmsKeyId
- automatic_
backup_ strreplication_ region - The destination region for the backup replication of the DB instance. For more info, see Replicating automated backups to another Region in the Amazon RDS User Guide.
- availability_
zone str - The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see Regions and Availability Zones. For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one. Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region. Constraints: + The
AvailabilityZone
parameter can't be specified if the DB instance is a Multi-AZ deployment. + The specified Availability Zone must be in the same AWS-Region as the current endpoint. Example:us-east-1d
- backup_
retention_ intperiod - The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Amazon Aurora Not applicable. The retention period for automated backups is managed by the DB cluster. Default: 1 Constraints: + Must be a value from 0 to 35 + Can't be set to 0 if the DB instance is a source to read replicas
- ca_
certificate_ stridentifier - The identifier of the CA certificate for this DB instance. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- certificate_
details CertificateDetails - The details of the DB instance's server certificate. Returns the details of the DB instance’s server certificate. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- certificate_
rotation_ boolrestart - Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate. By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. Set this parameter only if you are not using SSL/TLS to connect to the DB instance. If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate: + For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide. + For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide. This setting doesn't apply to RDS Custom DB instances.
- character_
set_ strname - For supported engines, indicates that the DB instance should be associated with the specified character set. Amazon Aurora Not applicable. The character set is managed by the DB cluster. For more information, see AWS::RDS::DBCluster.
- bool
- Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
- custom_
iam_ strinstance_ profile - The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. This setting is required for RDS Custom. Constraints: + The profile must exist in your account. + The profile must have an IAM role that Amazon EC2 has permissions to assume. + The instance profile name and the associated IAM role name must start with the prefix
AWSRDSCustom
. For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide. - db_
cluster_ stridentifier - The identifier of the DB cluster that the instance will belong to.
- db_
cluster_ strsnapshot_ identifier - The identifier for the Multi-AZ DB cluster snapshot to restore from. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide. Constraints: + Must match the identifier of an existing Multi-AZ DB cluster snapshot. + Can't be specified when
DBSnapshotIdentifier
is specified. + Must be specified whenDBSnapshotIdentifier
isn't specified. + If you are restoring from a shared manual Multi-AZ DB cluster snapshot, theDBClusterSnapshotIdentifier
must be the ARN of the shared snapshot. + Can't be the identifier of an Aurora DB cluster snapshot. - db_
instance_ strarn - Property dbInstanceArn
- db_
instance_ strclass - The compute and memory capacity of the DB instance, for example
db.m5.large
. Not all DB instance classes are available in all AWS-Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB instance classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide. - db_
instance_ stridentifier - A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see Name Type. For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
- db_
name str - The meaning of this parameter differs according to the database engine you use. If you specify the
DBSnapshotIdentifier
property, this property only applies to RDS for Oracle. Amazon Aurora Not applicable. The database name is managed by the DB cluster. Db2 The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. Constraints: + Must contain 1 to 64 letters or numbers. + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + Can't be a word reserved by the specified database engine. MySQL 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. Constraints: + Must contain 1 to 64 letters or numbers. + Can't be a word reserved by the specified database engine MariaDB 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. Constraints: + Must contain 1 to 64 letters or numbers. + Can't be a word reserved by the specified database engine PostgreSQL The name of the database to create when the DB instance is created. If this parameter is not specified, the defaultpostgres
database is created in the DB instance. Constraints: + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + Must contain 1 to 63 characters. + Can't be a word reserved by the specified database engine Oracle The Oracle System ID (SID) of the created DB instance. If you specifynull
, the default valueORCL
is used. You can't specify the string NULL, or any other reserved word, forDBName
. Default:ORCL
Constraints: + Can't be longer than 8 characters SQL Server Not applicable. Must be null. - db_
parameter_ strgroup_ name - The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template. To list all of the available DB parameter group names, use the following command:
aws rds describe-db-parameter-groups --query 'DBParameterGroups[].DBParameterGroupName' --output text
If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot. If you don't specify a value forDBParameterGroupName
property, the default DB parameter group for the specified engine and engine version is used. - db_
security_ Sequence[str]groups - A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template. If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups. If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations: +
AllocatedStorage
+AutoMinorVersionUpgrade
+AvailabilityZone
+BackupRetentionPeriod
+CharacterSetName
+DBInstanceClass
+DBName
+DBParameterGroupName
+DBSecurityGroups
+DBSubnetGroupName
+Engine
+EngineVersion
+Iops
+LicenseModel
+MasterUsername
+MasterUserPassword
+MultiAZ
+OptionGroupName
+PreferredBackupWindow
+PreferredMaintenanceWindow
All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such asStorageType
,StorageEncrypted
, orKmsKeyId
. If you're already using theDBSecurityGroups
property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance. - db_
snapshot_ stridentifier - The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot. By specifying this property, you can create a DB instance from the specified DB snapshot. If the
DBSnapshotIdentifier
property is an empty string or theAWS::RDS::DBInstance
declaration has noDBSnapshotIdentifier
property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack. Some DB instance properties aren't valid when you restore from a snapshot, such as theMasterUsername
andMasterUserPassword
properties. For information about the properties that you can specify, see theRestoreDBInstanceFromDBSnapshot
action in the Amazon RDS API Reference. After you restore a DB instance with aDBSnapshotIdentifier
property, you must specify the sameDBSnapshotIdentifier
property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify theDBSnapshotIdentifier
property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specifiedDBSnapshotIdentifier
property, and the original DB instance is deleted. If you specify theDBSnapshotIdentifier
property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties: +CharacterSetName
+DBClusterIdentifier
+DBName
+DeleteAutomatedBackups
+EnablePerformanceInsights
+KmsKeyId
+MasterUsername
+MasterUserPassword
+PerformanceInsightsKMSKeyId
+PerformanceInsightsRetentionPeriod
+PromotionTier
+SourceDBInstanceIdentifier
+SourceRegion
+StorageEncrypted
(for an encrypted snapshot) +Timezone
Amazon Aurora Not applicable. Snapshot restore is managed by the DB cluster. - db_
subnet_ strgroup_ name - A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC. If there's no DB subnet group, then the DB instance isn't a VPC DB instance. For more information about using Amazon RDS in a VPC, see Using Amazon RDS with Amazon Virtual Private Cloud (VPC) in the Amazon RDS User Guide. Amazon Aurora Not applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
- db_
system_ strid - The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term 'Oracle database instance' refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to
RDSCDB
. The Oracle SID is also the name of your CDB. - dbi_
resource_ strid - Property dbiResourceId
- dedicated_
log_ boolvolume - Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
- delete_
automated_ boolbackups - A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted. Amazon Aurora Not applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted.
- deletion_
protection bool - A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance. Amazon Aurora Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see
CreateDBCluster
. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster. - domain str
- The Active Directory directory ID to create the DB instance in. Currently, only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see Kerberos Authentication in the Amazon RDS User Guide.
- domain_
auth_ strsecret_ arn - The ARN for the Secrets Manager secret with the credentials for the user joining the domain. Example:
arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
- domain_
dns_ Sequence[str]ips - The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers. Constraints: + 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. Example:
123.124.125.126,234.235.236.237
- domain_
fqdn str - The fully qualified domain name (FQDN) of an Active Directory domain. Constraints: + Can't be longer than 64 characters. Example:
mymanagedADtest.mymanagedAD.mydomain
- domain_
iam_ strrole_ name - The name of the IAM role to use when making API calls to the Directory Service. This setting doesn't apply to the following DB instances: + Amazon Aurora (The domain is managed by the DB cluster.) + RDS Custom
- domain_
ou str - The Active Directory organizational unit for your DB instance to join. Constraints: + Must be in the distinguished name format. + Can't be longer than 64 characters. Example:
OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
- enable_
cloudwatch_ Sequence[str]logs_ exports - The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service User Guide. Amazon Aurora Not applicable. CloudWatch Logs exports are managed by the DB cluster. Db2 Valid values:
diag.log
,notify.log
MariaDB Valid values:audit
,error
,general
,slowquery
Microsoft SQL Server Valid values:agent
,error
MySQL Valid values:audit
,error
,general
,slowquery
Oracle Valid values:alert
,audit
,listener
,trace
,oemagent
PostgreSQL Valid values:postgresql
,upgrade
- enable_
iam_ booldatabase_ authentication - A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see IAM Database Authentication for MariaDB, MySQL, and PostgreSQL in the Amazon RDS User Guide. Amazon Aurora Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
- enable_
performance_ boolinsights - Specifies whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom DB instances.
- endpoint
Rds
Db Instance Endpoint - The connection endpoint for the DB instance. The endpoint might not be shown for instances with the status of
creating
. This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions: +CreateDBInstance
+DescribeDBInstances
+DeleteDBInstance
For the data structure that represents Amazon Aurora DB cluster endpoints, seeDBClusterEndpoint
. - engine str
- The name of the database engine to use for this DB instance. Not every database engine is available in every AWS Region. This property is required when creating a DB instance. You can change the architecture of an Oracle database from the non-container database (CDB) architecture to the CDB architecture by updating the
Engine
value in your templates fromoracle-ee
ororacle-ee-cdb
tooracle-se2-cdb
. Converting to the CDB architecture requires an interruption. Valid Values: +aurora-mysql
(for Aurora MySQL DB instances) +aurora-postgresql
(for Aurora PostgreSQL DB instances) +custom-oracle-ee
(for RDS Custom for Oracle DB instances) +custom-oracle-ee-cdb
(for RDS Custom for Oracle DB instances) +custom-sqlserver-ee
(for RDS Custom for SQL Server DB instances) +custom-sqlserver-se
(for RDS Custom for SQL Server DB instances) +custom-sqlserver-web
(for RDS Custom for SQL Server DB instances) +db2-ae
+db2-se
+mariadb
+mysql
+oracle-ee
+oracle-ee-cdb
+oracle-se2
+oracle-se2-cdb
+postgres
+sqlserver-ee
+sqlserver-se
+sqlserver-ex
+sqlserver-web
- engine_
version str - The version number of the database engine to use. For a list of valid engine versions, use the
DescribeDBEngineVersions
action. The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region. Amazon Aurora Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. Db2 See Amazon RDS for Db2 in the Amazon RDS User Guide. MariaDB See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide. Microsoft SQL Server See Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide. MySQL See MySQL on Amazon RDS Versions in the Amazon RDS User Guide. Oracle See Oracle Database Engine Release Notes in the Amazon RDS User Guide. PostgreSQL See Supported PostgreSQL Database Versions in the Amazon RDS User Guide. - iops int
- The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide. If you specify
io1
for theStorageType
property, then you must also specify theIops
property. Constraints: + For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance. + For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance. - kms_
key_ strid - The ARN of the AWS KMS key that's used to encrypt the DB instance, such as
arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef
. If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default KMS key. If you specify this property, you must set the StorageEncrypted property to true. If you specify theSourceDBInstanceIdentifier
property, the value is inherited from the source DB instance if the read replica is created in the same region. If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region. If you specify theSnapshotIdentifier
property, theStorageEncrypted
property value is inherited from the snapshot, and if the DB instance is encrypted, the specifiedKmsKeyId
property is used. If you specifyDBSecurityGroups
, AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see Using Amazon RDS with Amazon VPC in the Amazon RDS User Guide. Amazon Aurora Not applicable. The KMS key identifier is managed by the DB cluster. - license_
model str - License model information for this DB instance. Valid Values: + Aurora MySQL -
general-public-license
+ Aurora PostgreSQL -postgresql-license
+ RDS for Db2 -bring-your-own-license
. For more information about RDS for Db2 licensing, see in the Amazon RDS User Guide. + 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
orlicense-included
+ RDS for PostgreSQL -postgresql-license
If you've specifiedDBSecurityGroups
and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability. - manage_
master_ booluser_ password - Specifies whether to manage the master user password with AWS Secrets Manager. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide. Constraints: + Can't manage the master user password with AWS Secrets Manager if
MasterUserPassword
is specified. - master_
user_ strpassword - The password for the master user. The password can include any printable ASCII character except '/', ''', or '@'. Amazon Aurora Not applicable. The password for the master user is managed by the DB cluster. RDS for Db2 Must contain from 8 to 255 characters. RDS for MariaDB Constraints: Must contain from 8 to 41 characters. RDS for Microsoft SQL Server Constraints: Must contain from 8 to 128 characters. RDS for MySQL Constraints: Must contain from 8 to 41 characters. RDS for Oracle Constraints: Must contain from 8 to 30 characters. RDS for PostgreSQL Constraints: Must contain from 8 to 128 characters.
- master_
user_ Mastersecret User Secret - The secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide. The
MasterUserSecret
return value specifies the secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide and Password management with Secrets Manager in the Amazon Aurora User Guide. - master_
username str - The master user name for the DB instance. If you specify the
SourceDBInstanceIdentifier
orDBSnapshotIdentifier
property, don't specify this property. The value is inherited from the source DB instance or snapshot. When migrating a self-managed Db2 database, we recommend that you use the same master username as your self-managed Db2 instance name. Amazon Aurora Not applicable. The name for the master user is managed by the DB cluster. RDS for Db2 Constraints: + Must be 1 to 16 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for MariaDB Constraints: + Must be 1 to 16 letters or numbers. + Can't be a reserved word for the chosen database engine. RDS for Microsoft SQL Server Constraints: + Must be 1 to 128 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for MySQL Constraints: + Must be 1 to 16 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for Oracle Constraints: + Must be 1 to 30 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for PostgreSQL Constraints: + Must be 1 to 63 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. - max_
allocated_ intstorage - The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide. This setting doesn't apply to the following DB instances: + Amazon Aurora (Storage is managed by the DB cluster.) + RDS Custom
- monitoring_
interval int - The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0. If
MonitoringRoleArn
is specified, then you must setMonitoringInterval
to a value other than 0. This setting doesn't apply to RDS Custom. 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 Amazon CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide. IfMonitoringInterval
is set to a value other than0
, then you must supply aMonitoringRoleArn
value. This setting doesn't apply to RDS Custom DB instances. - multi_
az bool - Specifies whether the database instance is a Multi-AZ DB instance deployment. You can't set the
AvailabilityZone
parameter if theMultiAZ
parameter is set to true. For more information, see Multi-AZ deployments for high availability in the Amazon RDS User Guide. Amazon Aurora Not applicable. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require theMultiAZ
option to be set. - nchar_
character_ strset_ name - The name of the NCHAR character set for the Oracle DB instance. This setting doesn't apply to RDS Custom DB instances.
- network_
type str - The network type of the DB instance. Valid values: +
IPV4
+DUAL
The network type is determined by theDBSubnetGroup
specified for the DB instance. ADBSubnetGroup
can support only the IPv4 protocol or the IPv4 and IPv6 protocols (DUAL
). For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide. - option_
group_ strname - Indicates that the DB instance should be associated with the specified option group. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance.
- performance_
insights_ strkms_ key_ id - The AWS KMS key identifier for encryption of Performance Insights data. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for
PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region. For information about enabling Performance Insights, see EnablePerformanceInsights. - performance_
insights_ intretention_ period - The number of days to retain Performance Insights data. This setting doesn't apply to RDS Custom DB instances. Valid Values: +
7
+ month * 31, where month is a number of months from 1-23. Examples:93
(3 months * 31),341
(11 months * 31),589
(19 months * 31) +731
Default:7
days If you specify a retention period that isn't valid, such as94
, Amazon RDS returns an error. - port str
- The port number on which the database accepts connections. Amazon Aurora Not applicable. The port number is managed by the DB cluster. Db2 Default value:
50000
- preferred_
backup_ strwindow - The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod
parameter. For more information, see Backup Window in the Amazon RDS User Guide. Constraints: + Must be in the formathh24:mi-hh24:mi
. + Must be in Universal Coordinated Time (UTC). + Must not conflict with the preferred maintenance window. + Must be at least 30 minutes. Amazon Aurora Not applicable. The daily time range for creating automated backups is managed by the DB cluster. - preferred_
maintenance_ strwindow - The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format:
ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window in the Amazon RDS User Guide. This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately. Constraints: Minimum 30-minute window. - processor_
features Sequence[ProcessorFeature] - The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
- promotion_
tier int - The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide. This setting doesn't apply to RDS Custom DB instances. Default:
1
Valid Values:0 - 15
- publicly_
accessible bool - Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address. The default behavior value depends on your VPC setup and the database subnet group. For more information, see the
PubliclyAccessible
parameter in the CreateDBInstance in the Amazon RDS API Reference. - replica_
mode str - The open mode of an Oracle read replica. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide. This setting is only supported in RDS for Oracle. Default:
open-read-only
Valid Values:open-read-only
ormounted
- restore_
time str - The date and time to restore from. Constraints: + Must be a time in Universal Coordinated Time (UTC) format. + Must be before the latest restorable time for the DB instance. + Can't be specified if the
UseLatestRestorableTime
parameter is enabled. Example:2009-09-07T23:45:00Z
- source_
db_ strcluster_ identifier - The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas. Constraints: + Must be the identifier of an existing Multi-AZ DB cluster. + Can't be specified if the
SourceDBInstanceIdentifier
parameter is also specified. + The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0. + The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported. - source_
db_ strinstance_ automated_ backups_ arn - The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example,
arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE
. This setting doesn't apply to RDS Custom. - source_
db_ strinstance_ identifier - If you want to create a read replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of read replicas. For more information, see Working with Read Replicas in the Amazon RDS User Guide. For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide. The
SourceDBInstanceIdentifier
property determines whether a DB instance is a read replica. If you remove theSourceDBInstanceIdentifier
property from your template and then update your stack, AWS CloudFormation promotes the Read Replica to a standalone DB instance. + If you specify a source DB instance that uses VPC security groups, we recommend that you specify theVPCSecurityGroups
property. If you don't specify the property, the read replica inherits the value of theVPCSecurityGroups
property from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica'sVPCSecurityGroups
property to the default value because it's not defined in the stack's template. This change might cause unexpected issues. + Read replicas don't support deletion policies. AWS CloudFormation ignores any deletion policy that's associated with a read replica. + If you specifySourceDBInstanceIdentifier
, don't specify theDBSnapshotIdentifier
property. You can't create a read replica from a snapshot. + Don't set theBackupRetentionPeriod
,DBName
,MasterUsername
,MasterUserPassword
, andPreferredBackupWindow
properties. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas. + If the source DB instance is in a different region than the read replica, specify the source region inSourceRegion
, and specify an ARN for a valid DB instance inSourceDBInstanceIdentifier
. For more information, see Constructing a Amazon RDS Amazon Resource Name (ARN) in the Amazon RDS User Guide. + For DB instances in Amazon Aurora clusters, don't specify this property. Amazon RDS automatically assigns writer and reader DB instances. - source_
dbi_ strresource_ id - The resource ID of the source DB instance from which to restore.
- source_
region str - The ID of the region that contains the source DB instance for the read replica.
- storage_
encrypted bool - A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. If you specify the
KmsKeyId
property, then you must enable encryption. If you specify theSourceDBInstanceIdentifier
property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specifiedKmsKeyId
property is used. If you specify theDBSnapshotIdentifier
and the specified snapshot is encrypted, don't specify this property. The value is inherited from the snapshot, and the specifiedKmsKeyId
property is used. If you specify theDBSnapshotIdentifier
and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB instance is encrypted. Specify theKmsKeyId
property for the KMS key to use for encryption. If you don't want the restored DB instance to be encrypted, then don't set this property or set it tofalse
. Amazon Aurora Not applicable. The encryption for DB instances is managed by the DB cluster. - storage_
throughput int - Specifies the storage throughput value for the DB instance. This setting applies only to the
gp3
storage type. This setting doesn't apply to RDS Custom or Amazon Aurora. - storage_
type str - The storage type to associate with the DB instance. If you specify
io1
,io2
, orgp3
, you must also include a value for theIops
parameter. This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster. Valid Values:gp2 | gp3 | io1 | io2 | standard
Default:io1
, if theIops
parameter is specified. Otherwise,gp2
. - Sequence[Tag]
- An optional array of key-value pairs to apply to this DB instance.
- tde_
credential_ strarn - Property tdeCredentialArn
- tde_
credential_ strpassword - Property tdeCredentialPassword
- timezone str
- The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.
- use_
default_ boolprocessor_ features - Specifies whether the DB instance class of the DB instance uses its default processor features. This setting doesn't apply to RDS Custom DB instances.
- use_
latest_ boolrestorable_ time - Specifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time. Constraints: + Can't be specified if the
RestoreTime
parameter is provided. - vpc_
security_ Sequence[str]groups - A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to AWS::EC2::SecurityGroup resources created in the template. If you plan to update the resource, don't specify VPC security groups in a shared VPC. If you set
VPCSecurityGroups
, you must not set DBSecurityGroups, and vice versa. You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind: + You can't revert to using an RDS security group after you establish a VPC security group membership. + When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group. + To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the DBSecurityGroups property. To avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template. Amazon Aurora Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
- allocated
Storage String - The amount of storage in gibibytes (GiB) to be initially allocated for the database instance. If any value is set in the
Iops
parameter,AllocatedStorage
must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase theIops
value (in 1,000 IOPS increments), then you must also increase theAllocatedStorage
value (in 100-GiB increments). Amazon Aurora Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume. Db2 Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000. + Provisioned IOPS storage (io1): Must be an integer from 100 to 64000. MySQL Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. MariaDB Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. PostgreSQL Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. Oracle Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 10 to 3072. SQL Server Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): + Enterprise and Standard editions: Must be an integer from 20 to 16384. + Web and Express editions: Must be an integer from 20 to 16384. + Provisioned IOPS storage (io1): + Enterprise and Standard editions: Must be an integer from 20 to 16384. + Web and Express editions: Must be an integer from 20 to 16384. + Magnetic storage (standard): + Enterprise and Standard editions: Must be an integer from 20 to 1024. + Web and Express editions: Must be an integer from 20 to 1024. - allow
Major BooleanVersion Upgrade - A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Constraints: Major version upgrades must be allowed when specifying a value for the
EngineVersion
parameter that is a different major version than the DB instance's current version. - associated
Roles List<Property Map> - The IAMlong (IAM) roles associated with the DB instance. Amazon Aurora Not applicable. The associated roles are managed by the DB cluster.
- auto
Minor BooleanVersion Upgrade - A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.
- automatic
Backup StringReplication Kms Key Id - Property automaticBackupReplicationKmsKeyId
- automatic
Backup StringReplication Region - The destination region for the backup replication of the DB instance. For more info, see Replicating automated backups to another Region in the Amazon RDS User Guide.
- availability
Zone String - The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see Regions and Availability Zones. For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one. Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region. Constraints: + The
AvailabilityZone
parameter can't be specified if the DB instance is a Multi-AZ deployment. + The specified Availability Zone must be in the same AWS-Region as the current endpoint. Example:us-east-1d
- backup
Retention NumberPeriod - The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Amazon Aurora Not applicable. The retention period for automated backups is managed by the DB cluster. Default: 1 Constraints: + Must be a value from 0 to 35 + Can't be set to 0 if the DB instance is a source to read replicas
- ca
Certificate StringIdentifier - The identifier of the CA certificate for this DB instance. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- certificate
Details Property Map - The details of the DB instance's server certificate. Returns the details of the DB instance’s server certificate. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- certificate
Rotation BooleanRestart - Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate. By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. Set this parameter only if you are not using SSL/TLS to connect to the DB instance. If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate: + For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide. + For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide. This setting doesn't apply to RDS Custom DB instances.
- character
Set StringName - For supported engines, indicates that the DB instance should be associated with the specified character set. Amazon Aurora Not applicable. The character set is managed by the DB cluster. For more information, see AWS::RDS::DBCluster.
- Boolean
- Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
- custom
IAMInstance StringProfile - The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. This setting is required for RDS Custom. Constraints: + The profile must exist in your account. + The profile must have an IAM role that Amazon EC2 has permissions to assume. + The instance profile name and the associated IAM role name must start with the prefix
AWSRDSCustom
. For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide. - db
Cluster StringIdentifier - The identifier of the DB cluster that the instance will belong to.
- db
Cluster StringSnapshot Identifier - The identifier for the Multi-AZ DB cluster snapshot to restore from. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide. Constraints: + Must match the identifier of an existing Multi-AZ DB cluster snapshot. + Can't be specified when
DBSnapshotIdentifier
is specified. + Must be specified whenDBSnapshotIdentifier
isn't specified. + If you are restoring from a shared manual Multi-AZ DB cluster snapshot, theDBClusterSnapshotIdentifier
must be the ARN of the shared snapshot. + Can't be the identifier of an Aurora DB cluster snapshot. - db
Instance StringArn - Property dbInstanceArn
- db
Instance StringClass - The compute and memory capacity of the DB instance, for example
db.m5.large
. Not all DB instance classes are available in all AWS-Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB instance classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide. - db
Instance StringIdentifier - A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see Name Type. For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
- db
Name String - The meaning of this parameter differs according to the database engine you use. If you specify the
DBSnapshotIdentifier
property, this property only applies to RDS for Oracle. Amazon Aurora Not applicable. The database name is managed by the DB cluster. Db2 The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. Constraints: + Must contain 1 to 64 letters or numbers. + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + Can't be a word reserved by the specified database engine. MySQL 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. Constraints: + Must contain 1 to 64 letters or numbers. + Can't be a word reserved by the specified database engine MariaDB 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. Constraints: + Must contain 1 to 64 letters or numbers. + Can't be a word reserved by the specified database engine PostgreSQL The name of the database to create when the DB instance is created. If this parameter is not specified, the defaultpostgres
database is created in the DB instance. Constraints: + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + Must contain 1 to 63 characters. + Can't be a word reserved by the specified database engine Oracle The Oracle System ID (SID) of the created DB instance. If you specifynull
, the default valueORCL
is used. You can't specify the string NULL, or any other reserved word, forDBName
. Default:ORCL
Constraints: + Can't be longer than 8 characters SQL Server Not applicable. Must be null. - db
Parameter StringGroup Name - The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template. To list all of the available DB parameter group names, use the following command:
aws rds describe-db-parameter-groups --query 'DBParameterGroups[].DBParameterGroupName' --output text
If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot. If you don't specify a value forDBParameterGroupName
property, the default DB parameter group for the specified engine and engine version is used. - db
Security List<String>Groups - A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template. If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups. If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations: +
AllocatedStorage
+AutoMinorVersionUpgrade
+AvailabilityZone
+BackupRetentionPeriod
+CharacterSetName
+DBInstanceClass
+DBName
+DBParameterGroupName
+DBSecurityGroups
+DBSubnetGroupName
+Engine
+EngineVersion
+Iops
+LicenseModel
+MasterUsername
+MasterUserPassword
+MultiAZ
+OptionGroupName
+PreferredBackupWindow
+PreferredMaintenanceWindow
All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such asStorageType
,StorageEncrypted
, orKmsKeyId
. If you're already using theDBSecurityGroups
property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance. - db
Snapshot StringIdentifier - The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot. By specifying this property, you can create a DB instance from the specified DB snapshot. If the
DBSnapshotIdentifier
property is an empty string or theAWS::RDS::DBInstance
declaration has noDBSnapshotIdentifier
property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack. Some DB instance properties aren't valid when you restore from a snapshot, such as theMasterUsername
andMasterUserPassword
properties. For information about the properties that you can specify, see theRestoreDBInstanceFromDBSnapshot
action in the Amazon RDS API Reference. After you restore a DB instance with aDBSnapshotIdentifier
property, you must specify the sameDBSnapshotIdentifier
property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify theDBSnapshotIdentifier
property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specifiedDBSnapshotIdentifier
property, and the original DB instance is deleted. If you specify theDBSnapshotIdentifier
property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties: +CharacterSetName
+DBClusterIdentifier
+DBName
+DeleteAutomatedBackups
+EnablePerformanceInsights
+KmsKeyId
+MasterUsername
+MasterUserPassword
+PerformanceInsightsKMSKeyId
+PerformanceInsightsRetentionPeriod
+PromotionTier
+SourceDBInstanceIdentifier
+SourceRegion
+StorageEncrypted
(for an encrypted snapshot) +Timezone
Amazon Aurora Not applicable. Snapshot restore is managed by the DB cluster. - db
Subnet StringGroup Name - A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC. If there's no DB subnet group, then the DB instance isn't a VPC DB instance. For more information about using Amazon RDS in a VPC, see Using Amazon RDS with Amazon Virtual Private Cloud (VPC) in the Amazon RDS User Guide. Amazon Aurora Not applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
- db
System StringId - The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term 'Oracle database instance' refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to
RDSCDB
. The Oracle SID is also the name of your CDB. - dbi
Resource StringId - Property dbiResourceId
- dedicated
Log BooleanVolume - Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
- delete
Automated BooleanBackups - A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted. Amazon Aurora Not applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted.
- deletion
Protection Boolean - A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance. Amazon Aurora Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see
CreateDBCluster
. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster. - domain String
- The Active Directory directory ID to create the DB instance in. Currently, only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see Kerberos Authentication in the Amazon RDS User Guide.
- domain
Auth StringSecret Arn - The ARN for the Secrets Manager secret with the credentials for the user joining the domain. Example:
arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
- domain
Dns List<String>Ips - The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers. Constraints: + 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. Example:
123.124.125.126,234.235.236.237
- domain
Fqdn String - The fully qualified domain name (FQDN) of an Active Directory domain. Constraints: + Can't be longer than 64 characters. Example:
mymanagedADtest.mymanagedAD.mydomain
- domain
IAMRole StringName - The name of the IAM role to use when making API calls to the Directory Service. This setting doesn't apply to the following DB instances: + Amazon Aurora (The domain is managed by the DB cluster.) + RDS Custom
- domain
Ou String - The Active Directory organizational unit for your DB instance to join. Constraints: + Must be in the distinguished name format. + Can't be longer than 64 characters. Example:
OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
- enable
Cloudwatch List<String>Logs Exports - The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service User Guide. Amazon Aurora Not applicable. CloudWatch Logs exports are managed by the DB cluster. Db2 Valid values:
diag.log
,notify.log
MariaDB Valid values:audit
,error
,general
,slowquery
Microsoft SQL Server Valid values:agent
,error
MySQL Valid values:audit
,error
,general
,slowquery
Oracle Valid values:alert
,audit
,listener
,trace
,oemagent
PostgreSQL Valid values:postgresql
,upgrade
- enable
IAMDatabase BooleanAuthentication - A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see IAM Database Authentication for MariaDB, MySQL, and PostgreSQL in the Amazon RDS User Guide. Amazon Aurora Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
- enable
Performance BooleanInsights - Specifies whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom DB instances.
- endpoint Property Map
- The connection endpoint for the DB instance. The endpoint might not be shown for instances with the status of
creating
. This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions: +CreateDBInstance
+DescribeDBInstances
+DeleteDBInstance
For the data structure that represents Amazon Aurora DB cluster endpoints, seeDBClusterEndpoint
. - engine String
- The name of the database engine to use for this DB instance. Not every database engine is available in every AWS Region. This property is required when creating a DB instance. You can change the architecture of an Oracle database from the non-container database (CDB) architecture to the CDB architecture by updating the
Engine
value in your templates fromoracle-ee
ororacle-ee-cdb
tooracle-se2-cdb
. Converting to the CDB architecture requires an interruption. Valid Values: +aurora-mysql
(for Aurora MySQL DB instances) +aurora-postgresql
(for Aurora PostgreSQL DB instances) +custom-oracle-ee
(for RDS Custom for Oracle DB instances) +custom-oracle-ee-cdb
(for RDS Custom for Oracle DB instances) +custom-sqlserver-ee
(for RDS Custom for SQL Server DB instances) +custom-sqlserver-se
(for RDS Custom for SQL Server DB instances) +custom-sqlserver-web
(for RDS Custom for SQL Server DB instances) +db2-ae
+db2-se
+mariadb
+mysql
+oracle-ee
+oracle-ee-cdb
+oracle-se2
+oracle-se2-cdb
+postgres
+sqlserver-ee
+sqlserver-se
+sqlserver-ex
+sqlserver-web
- engine
Version String - The version number of the database engine to use. For a list of valid engine versions, use the
DescribeDBEngineVersions
action. The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region. Amazon Aurora Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. Db2 See Amazon RDS for Db2 in the Amazon RDS User Guide. MariaDB See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide. Microsoft SQL Server See Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide. MySQL See MySQL on Amazon RDS Versions in the Amazon RDS User Guide. Oracle See Oracle Database Engine Release Notes in the Amazon RDS User Guide. PostgreSQL See Supported PostgreSQL Database Versions in the Amazon RDS User Guide. - iops Number
- The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide. If you specify
io1
for theStorageType
property, then you must also specify theIops
property. Constraints: + For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance. + For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance. - kms
Key StringId - The ARN of the AWS KMS key that's used to encrypt the DB instance, such as
arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef
. If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default KMS key. If you specify this property, you must set the StorageEncrypted property to true. If you specify theSourceDBInstanceIdentifier
property, the value is inherited from the source DB instance if the read replica is created in the same region. If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region. If you specify theSnapshotIdentifier
property, theStorageEncrypted
property value is inherited from the snapshot, and if the DB instance is encrypted, the specifiedKmsKeyId
property is used. If you specifyDBSecurityGroups
, AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see Using Amazon RDS with Amazon VPC in the Amazon RDS User Guide. Amazon Aurora Not applicable. The KMS key identifier is managed by the DB cluster. - license
Model String - License model information for this DB instance. Valid Values: + Aurora MySQL -
general-public-license
+ Aurora PostgreSQL -postgresql-license
+ RDS for Db2 -bring-your-own-license
. For more information about RDS for Db2 licensing, see in the Amazon RDS User Guide. + 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
orlicense-included
+ RDS for PostgreSQL -postgresql-license
If you've specifiedDBSecurityGroups
and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability. - manage
Master BooleanUser Password - Specifies whether to manage the master user password with AWS Secrets Manager. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide. Constraints: + Can't manage the master user password with AWS Secrets Manager if
MasterUserPassword
is specified. - master
User StringPassword - The password for the master user. The password can include any printable ASCII character except '/', ''', or '@'. Amazon Aurora Not applicable. The password for the master user is managed by the DB cluster. RDS for Db2 Must contain from 8 to 255 characters. RDS for MariaDB Constraints: Must contain from 8 to 41 characters. RDS for Microsoft SQL Server Constraints: Must contain from 8 to 128 characters. RDS for MySQL Constraints: Must contain from 8 to 41 characters. RDS for Oracle Constraints: Must contain from 8 to 30 characters. RDS for PostgreSQL Constraints: Must contain from 8 to 128 characters.
- master
User Property MapSecret - The secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide. The
MasterUserSecret
return value specifies the secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide and Password management with Secrets Manager in the Amazon Aurora User Guide. - master
Username String - The master user name for the DB instance. If you specify the
SourceDBInstanceIdentifier
orDBSnapshotIdentifier
property, don't specify this property. The value is inherited from the source DB instance or snapshot. When migrating a self-managed Db2 database, we recommend that you use the same master username as your self-managed Db2 instance name. Amazon Aurora Not applicable. The name for the master user is managed by the DB cluster. RDS for Db2 Constraints: + Must be 1 to 16 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for MariaDB Constraints: + Must be 1 to 16 letters or numbers. + Can't be a reserved word for the chosen database engine. RDS for Microsoft SQL Server Constraints: + Must be 1 to 128 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for MySQL Constraints: + Must be 1 to 16 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for Oracle Constraints: + Must be 1 to 30 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for PostgreSQL Constraints: + Must be 1 to 63 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. - max
Allocated NumberStorage - The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide. This setting doesn't apply to the following DB instances: + Amazon Aurora (Storage is managed by the DB cluster.) + RDS Custom
- monitoring
Interval Number - The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0. If
MonitoringRoleArn
is specified, then you must setMonitoringInterval
to a value other than 0. This setting doesn't apply to RDS Custom. 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 Amazon CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide. IfMonitoringInterval
is set to a value other than0
, then you must supply aMonitoringRoleArn
value. This setting doesn't apply to RDS Custom DB instances. - multi
AZ Boolean - Specifies whether the database instance is a Multi-AZ DB instance deployment. You can't set the
AvailabilityZone
parameter if theMultiAZ
parameter is set to true. For more information, see Multi-AZ deployments for high availability in the Amazon RDS User Guide. Amazon Aurora Not applicable. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require theMultiAZ
option to be set. - nchar
Character StringSet Name - The name of the NCHAR character set for the Oracle DB instance. This setting doesn't apply to RDS Custom DB instances.
- network
Type String - The network type of the DB instance. Valid values: +
IPV4
+DUAL
The network type is determined by theDBSubnetGroup
specified for the DB instance. ADBSubnetGroup
can support only the IPv4 protocol or the IPv4 and IPv6 protocols (DUAL
). For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide. - option
Group StringName - Indicates that the DB instance should be associated with the specified option group. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance.
- performance
Insights StringKMSKey Id - The AWS KMS key identifier for encryption of Performance Insights data. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for
PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region. For information about enabling Performance Insights, see EnablePerformanceInsights. - performance
Insights NumberRetention Period - The number of days to retain Performance Insights data. This setting doesn't apply to RDS Custom DB instances. Valid Values: +
7
+ month * 31, where month is a number of months from 1-23. Examples:93
(3 months * 31),341
(11 months * 31),589
(19 months * 31) +731
Default:7
days If you specify a retention period that isn't valid, such as94
, Amazon RDS returns an error. - port String
- The port number on which the database accepts connections. Amazon Aurora Not applicable. The port number is managed by the DB cluster. Db2 Default value:
50000
- preferred
Backup StringWindow - The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod
parameter. For more information, see Backup Window in the Amazon RDS User Guide. Constraints: + Must be in the formathh24:mi-hh24:mi
. + Must be in Universal Coordinated Time (UTC). + Must not conflict with the preferred maintenance window. + Must be at least 30 minutes. Amazon Aurora Not applicable. The daily time range for creating automated backups is managed by the DB cluster. - preferred
Maintenance StringWindow - The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format:
ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window in the Amazon RDS User Guide. This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately. Constraints: Minimum 30-minute window. - processor
Features List<Property Map> - The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
- promotion
Tier Number - The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide. This setting doesn't apply to RDS Custom DB instances. Default:
1
Valid Values:0 - 15
- publicly
Accessible Boolean - Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address. The default behavior value depends on your VPC setup and the database subnet group. For more information, see the
PubliclyAccessible
parameter in the CreateDBInstance in the Amazon RDS API Reference. - replica
Mode String - The open mode of an Oracle read replica. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide. This setting is only supported in RDS for Oracle. Default:
open-read-only
Valid Values:open-read-only
ormounted
- restore
Time String - The date and time to restore from. Constraints: + Must be a time in Universal Coordinated Time (UTC) format. + Must be before the latest restorable time for the DB instance. + Can't be specified if the
UseLatestRestorableTime
parameter is enabled. Example:2009-09-07T23:45:00Z
- source
DBCluster StringIdentifier - The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas. Constraints: + Must be the identifier of an existing Multi-AZ DB cluster. + Can't be specified if the
SourceDBInstanceIdentifier
parameter is also specified. + The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0. + The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported. - source
DBInstance StringAutomated Backups Arn - The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example,
arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE
. This setting doesn't apply to RDS Custom. - source
DBInstance StringIdentifier - If you want to create a read replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of read replicas. For more information, see Working with Read Replicas in the Amazon RDS User Guide. For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide. The
SourceDBInstanceIdentifier
property determines whether a DB instance is a read replica. If you remove theSourceDBInstanceIdentifier
property from your template and then update your stack, AWS CloudFormation promotes the Read Replica to a standalone DB instance. + If you specify a source DB instance that uses VPC security groups, we recommend that you specify theVPCSecurityGroups
property. If you don't specify the property, the read replica inherits the value of theVPCSecurityGroups
property from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica'sVPCSecurityGroups
property to the default value because it's not defined in the stack's template. This change might cause unexpected issues. + Read replicas don't support deletion policies. AWS CloudFormation ignores any deletion policy that's associated with a read replica. + If you specifySourceDBInstanceIdentifier
, don't specify theDBSnapshotIdentifier
property. You can't create a read replica from a snapshot. + Don't set theBackupRetentionPeriod
,DBName
,MasterUsername
,MasterUserPassword
, andPreferredBackupWindow
properties. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas. + If the source DB instance is in a different region than the read replica, specify the source region inSourceRegion
, and specify an ARN for a valid DB instance inSourceDBInstanceIdentifier
. For more information, see Constructing a Amazon RDS Amazon Resource Name (ARN) in the Amazon RDS User Guide. + For DB instances in Amazon Aurora clusters, don't specify this property. Amazon RDS automatically assigns writer and reader DB instances. - source
Dbi StringResource Id - The resource ID of the source DB instance from which to restore.
- source
Region String - The ID of the region that contains the source DB instance for the read replica.
- storage
Encrypted Boolean - A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. If you specify the
KmsKeyId
property, then you must enable encryption. If you specify theSourceDBInstanceIdentifier
property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specifiedKmsKeyId
property is used. If you specify theDBSnapshotIdentifier
and the specified snapshot is encrypted, don't specify this property. The value is inherited from the snapshot, and the specifiedKmsKeyId
property is used. If you specify theDBSnapshotIdentifier
and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB instance is encrypted. Specify theKmsKeyId
property for the KMS key to use for encryption. If you don't want the restored DB instance to be encrypted, then don't set this property or set it tofalse
. Amazon Aurora Not applicable. The encryption for DB instances is managed by the DB cluster. - storage
Throughput Number - Specifies the storage throughput value for the DB instance. This setting applies only to the
gp3
storage type. This setting doesn't apply to RDS Custom or Amazon Aurora. - storage
Type String - The storage type to associate with the DB instance. If you specify
io1
,io2
, orgp3
, you must also include a value for theIops
parameter. This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster. Valid Values:gp2 | gp3 | io1 | io2 | standard
Default:io1
, if theIops
parameter is specified. Otherwise,gp2
. - List<Property Map>
- An optional array of key-value pairs to apply to this DB instance.
- tde
Credential StringArn - Property tdeCredentialArn
- tde
Credential StringPassword - Property tdeCredentialPassword
- timezone String
- The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.
- use
Default BooleanProcessor Features - Specifies whether the DB instance class of the DB instance uses its default processor features. This setting doesn't apply to RDS Custom DB instances.
- use
Latest BooleanRestorable Time - Specifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time. Constraints: + Can't be specified if the
RestoreTime
parameter is provided. - vpc
Security List<String>Groups - A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to AWS::EC2::SecurityGroup resources created in the template. If you plan to update the resource, don't specify VPC security groups in a shared VPC. If you set
VPCSecurityGroups
, you must not set DBSecurityGroups, and vice versa. You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind: + You can't revert to using an RDS security group after you establish a VPC security group membership. + When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group. + To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the DBSecurityGroups property. To avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template. Amazon Aurora Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
AwsRdsDBInstancePropertiesResponse, AwsRdsDBInstancePropertiesResponseArgs
- Allocated
Storage string - The amount of storage in gibibytes (GiB) to be initially allocated for the database instance. If any value is set in the
Iops
parameter,AllocatedStorage
must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase theIops
value (in 1,000 IOPS increments), then you must also increase theAllocatedStorage
value (in 100-GiB increments). Amazon Aurora Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume. Db2 Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000. + Provisioned IOPS storage (io1): Must be an integer from 100 to 64000. MySQL Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. MariaDB Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. PostgreSQL Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. Oracle Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 10 to 3072. SQL Server Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): + Enterprise and Standard editions: Must be an integer from 20 to 16384. + Web and Express editions: Must be an integer from 20 to 16384. + Provisioned IOPS storage (io1): + Enterprise and Standard editions: Must be an integer from 20 to 16384. + Web and Express editions: Must be an integer from 20 to 16384. + Magnetic storage (standard): + Enterprise and Standard editions: Must be an integer from 20 to 1024. + Web and Express editions: Must be an integer from 20 to 1024. - Allow
Major boolVersion Upgrade - A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Constraints: Major version upgrades must be allowed when specifying a value for the
EngineVersion
parameter that is a different major version than the DB instance's current version. - Associated
Roles List<Pulumi.Azure Native. Aws Connector. Inputs. DBInstance Role Response> - The IAMlong (IAM) roles associated with the DB instance. Amazon Aurora Not applicable. The associated roles are managed by the DB cluster.
- Auto
Minor boolVersion Upgrade - A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.
- Automatic
Backup stringReplication Kms Key Id - Property automaticBackupReplicationKmsKeyId
- Automatic
Backup stringReplication Region - The destination region for the backup replication of the DB instance. For more info, see Replicating automated backups to another Region in the Amazon RDS User Guide.
- Availability
Zone string - The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see Regions and Availability Zones. For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one. Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region. Constraints: + The
AvailabilityZone
parameter can't be specified if the DB instance is a Multi-AZ deployment. + The specified Availability Zone must be in the same AWS-Region as the current endpoint. Example:us-east-1d
- Backup
Retention intPeriod - The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Amazon Aurora Not applicable. The retention period for automated backups is managed by the DB cluster. Default: 1 Constraints: + Must be a value from 0 to 35 + Can't be set to 0 if the DB instance is a source to read replicas
- Ca
Certificate stringIdentifier - The identifier of the CA certificate for this DB instance. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- Certificate
Details Pulumi.Azure Native. Aws Connector. Inputs. Certificate Details Response - The details of the DB instance's server certificate. Returns the details of the DB instance’s server certificate. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- Certificate
Rotation boolRestart - Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate. By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. Set this parameter only if you are not using SSL/TLS to connect to the DB instance. If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate: + For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide. + For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide. This setting doesn't apply to RDS Custom DB instances.
- Character
Set stringName - For supported engines, indicates that the DB instance should be associated with the specified character set. Amazon Aurora Not applicable. The character set is managed by the DB cluster. For more information, see AWS::RDS::DBCluster.
- bool
- Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
- Custom
IAMInstance stringProfile - The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. This setting is required for RDS Custom. Constraints: + The profile must exist in your account. + The profile must have an IAM role that Amazon EC2 has permissions to assume. + The instance profile name and the associated IAM role name must start with the prefix
AWSRDSCustom
. For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide. - Db
Cluster stringIdentifier - The identifier of the DB cluster that the instance will belong to.
- Db
Cluster stringSnapshot Identifier - The identifier for the Multi-AZ DB cluster snapshot to restore from. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide. Constraints: + Must match the identifier of an existing Multi-AZ DB cluster snapshot. + Can't be specified when
DBSnapshotIdentifier
is specified. + Must be specified whenDBSnapshotIdentifier
isn't specified. + If you are restoring from a shared manual Multi-AZ DB cluster snapshot, theDBClusterSnapshotIdentifier
must be the ARN of the shared snapshot. + Can't be the identifier of an Aurora DB cluster snapshot. - Db
Instance stringArn - Property dbInstanceArn
- Db
Instance stringClass - The compute and memory capacity of the DB instance, for example
db.m5.large
. Not all DB instance classes are available in all AWS-Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB instance classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide. - Db
Instance stringIdentifier - A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see Name Type. For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
- Db
Name string - The meaning of this parameter differs according to the database engine you use. If you specify the
DBSnapshotIdentifier
property, this property only applies to RDS for Oracle. Amazon Aurora Not applicable. The database name is managed by the DB cluster. Db2 The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. Constraints: + Must contain 1 to 64 letters or numbers. + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + Can't be a word reserved by the specified database engine. MySQL 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. Constraints: + Must contain 1 to 64 letters or numbers. + Can't be a word reserved by the specified database engine MariaDB 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. Constraints: + Must contain 1 to 64 letters or numbers. + Can't be a word reserved by the specified database engine PostgreSQL The name of the database to create when the DB instance is created. If this parameter is not specified, the defaultpostgres
database is created in the DB instance. Constraints: + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + Must contain 1 to 63 characters. + Can't be a word reserved by the specified database engine Oracle The Oracle System ID (SID) of the created DB instance. If you specifynull
, the default valueORCL
is used. You can't specify the string NULL, or any other reserved word, forDBName
. Default:ORCL
Constraints: + Can't be longer than 8 characters SQL Server Not applicable. Must be null. - Db
Parameter stringGroup Name - The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template. To list all of the available DB parameter group names, use the following command:
aws rds describe-db-parameter-groups --query 'DBParameterGroups[].DBParameterGroupName' --output text
If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot. If you don't specify a value forDBParameterGroupName
property, the default DB parameter group for the specified engine and engine version is used. - Db
Security List<string>Groups - A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template. If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups. If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations: +
AllocatedStorage
+AutoMinorVersionUpgrade
+AvailabilityZone
+BackupRetentionPeriod
+CharacterSetName
+DBInstanceClass
+DBName
+DBParameterGroupName
+DBSecurityGroups
+DBSubnetGroupName
+Engine
+EngineVersion
+Iops
+LicenseModel
+MasterUsername
+MasterUserPassword
+MultiAZ
+OptionGroupName
+PreferredBackupWindow
+PreferredMaintenanceWindow
All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such asStorageType
,StorageEncrypted
, orKmsKeyId
. If you're already using theDBSecurityGroups
property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance. - Db
Snapshot stringIdentifier - The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot. By specifying this property, you can create a DB instance from the specified DB snapshot. If the
DBSnapshotIdentifier
property is an empty string or theAWS::RDS::DBInstance
declaration has noDBSnapshotIdentifier
property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack. Some DB instance properties aren't valid when you restore from a snapshot, such as theMasterUsername
andMasterUserPassword
properties. For information about the properties that you can specify, see theRestoreDBInstanceFromDBSnapshot
action in the Amazon RDS API Reference. After you restore a DB instance with aDBSnapshotIdentifier
property, you must specify the sameDBSnapshotIdentifier
property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify theDBSnapshotIdentifier
property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specifiedDBSnapshotIdentifier
property, and the original DB instance is deleted. If you specify theDBSnapshotIdentifier
property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties: +CharacterSetName
+DBClusterIdentifier
+DBName
+DeleteAutomatedBackups
+EnablePerformanceInsights
+KmsKeyId
+MasterUsername
+MasterUserPassword
+PerformanceInsightsKMSKeyId
+PerformanceInsightsRetentionPeriod
+PromotionTier
+SourceDBInstanceIdentifier
+SourceRegion
+StorageEncrypted
(for an encrypted snapshot) +Timezone
Amazon Aurora Not applicable. Snapshot restore is managed by the DB cluster. - Db
Subnet stringGroup Name - A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC. If there's no DB subnet group, then the DB instance isn't a VPC DB instance. For more information about using Amazon RDS in a VPC, see Using Amazon RDS with Amazon Virtual Private Cloud (VPC) in the Amazon RDS User Guide. Amazon Aurora Not applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
- Db
System stringId - The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term 'Oracle database instance' refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to
RDSCDB
. The Oracle SID is also the name of your CDB. - Dbi
Resource stringId - Property dbiResourceId
- Dedicated
Log boolVolume - Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
- Delete
Automated boolBackups - A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted. Amazon Aurora Not applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted.
- Deletion
Protection bool - A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance. Amazon Aurora Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see
CreateDBCluster
. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster. - Domain string
- The Active Directory directory ID to create the DB instance in. Currently, only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see Kerberos Authentication in the Amazon RDS User Guide.
- Domain
Auth stringSecret Arn - The ARN for the Secrets Manager secret with the credentials for the user joining the domain. Example:
arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
- Domain
Dns List<string>Ips - The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers. Constraints: + 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. Example:
123.124.125.126,234.235.236.237
- Domain
Fqdn string - The fully qualified domain name (FQDN) of an Active Directory domain. Constraints: + Can't be longer than 64 characters. Example:
mymanagedADtest.mymanagedAD.mydomain
- Domain
IAMRole stringName - The name of the IAM role to use when making API calls to the Directory Service. This setting doesn't apply to the following DB instances: + Amazon Aurora (The domain is managed by the DB cluster.) + RDS Custom
- Domain
Ou string - The Active Directory organizational unit for your DB instance to join. Constraints: + Must be in the distinguished name format. + Can't be longer than 64 characters. Example:
OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
- Enable
Cloudwatch List<string>Logs Exports - The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service User Guide. Amazon Aurora Not applicable. CloudWatch Logs exports are managed by the DB cluster. Db2 Valid values:
diag.log
,notify.log
MariaDB Valid values:audit
,error
,general
,slowquery
Microsoft SQL Server Valid values:agent
,error
MySQL Valid values:audit
,error
,general
,slowquery
Oracle Valid values:alert
,audit
,listener
,trace
,oemagent
PostgreSQL Valid values:postgresql
,upgrade
- Enable
IAMDatabase boolAuthentication - A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see IAM Database Authentication for MariaDB, MySQL, and PostgreSQL in the Amazon RDS User Guide. Amazon Aurora Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
- Enable
Performance boolInsights - Specifies whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom DB instances.
- Endpoint
Pulumi.
Azure Native. Aws Connector. Inputs. Rds Db Instance Endpoint Response - The connection endpoint for the DB instance. The endpoint might not be shown for instances with the status of
creating
. This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions: +CreateDBInstance
+DescribeDBInstances
+DeleteDBInstance
For the data structure that represents Amazon Aurora DB cluster endpoints, seeDBClusterEndpoint
. - Engine string
- The name of the database engine to use for this DB instance. Not every database engine is available in every AWS Region. This property is required when creating a DB instance. You can change the architecture of an Oracle database from the non-container database (CDB) architecture to the CDB architecture by updating the
Engine
value in your templates fromoracle-ee
ororacle-ee-cdb
tooracle-se2-cdb
. Converting to the CDB architecture requires an interruption. Valid Values: +aurora-mysql
(for Aurora MySQL DB instances) +aurora-postgresql
(for Aurora PostgreSQL DB instances) +custom-oracle-ee
(for RDS Custom for Oracle DB instances) +custom-oracle-ee-cdb
(for RDS Custom for Oracle DB instances) +custom-sqlserver-ee
(for RDS Custom for SQL Server DB instances) +custom-sqlserver-se
(for RDS Custom for SQL Server DB instances) +custom-sqlserver-web
(for RDS Custom for SQL Server DB instances) +db2-ae
+db2-se
+mariadb
+mysql
+oracle-ee
+oracle-ee-cdb
+oracle-se2
+oracle-se2-cdb
+postgres
+sqlserver-ee
+sqlserver-se
+sqlserver-ex
+sqlserver-web
- Engine
Version string - The version number of the database engine to use. For a list of valid engine versions, use the
DescribeDBEngineVersions
action. The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region. Amazon Aurora Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. Db2 See Amazon RDS for Db2 in the Amazon RDS User Guide. MariaDB See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide. Microsoft SQL Server See Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide. MySQL See MySQL on Amazon RDS Versions in the Amazon RDS User Guide. Oracle See Oracle Database Engine Release Notes in the Amazon RDS User Guide. PostgreSQL See Supported PostgreSQL Database Versions in the Amazon RDS User Guide. - Iops int
- The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide. If you specify
io1
for theStorageType
property, then you must also specify theIops
property. Constraints: + For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance. + For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance. - Kms
Key stringId - The ARN of the AWS KMS key that's used to encrypt the DB instance, such as
arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef
. If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default KMS key. If you specify this property, you must set the StorageEncrypted property to true. If you specify theSourceDBInstanceIdentifier
property, the value is inherited from the source DB instance if the read replica is created in the same region. If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region. If you specify theSnapshotIdentifier
property, theStorageEncrypted
property value is inherited from the snapshot, and if the DB instance is encrypted, the specifiedKmsKeyId
property is used. If you specifyDBSecurityGroups
, AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see Using Amazon RDS with Amazon VPC in the Amazon RDS User Guide. Amazon Aurora Not applicable. The KMS key identifier is managed by the DB cluster. - License
Model string - License model information for this DB instance. Valid Values: + Aurora MySQL -
general-public-license
+ Aurora PostgreSQL -postgresql-license
+ RDS for Db2 -bring-your-own-license
. For more information about RDS for Db2 licensing, see in the Amazon RDS User Guide. + 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
orlicense-included
+ RDS for PostgreSQL -postgresql-license
If you've specifiedDBSecurityGroups
and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability. - Manage
Master boolUser Password - Specifies whether to manage the master user password with AWS Secrets Manager. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide. Constraints: + Can't manage the master user password with AWS Secrets Manager if
MasterUserPassword
is specified. - Master
User stringPassword - The password for the master user. The password can include any printable ASCII character except '/', ''', or '@'. Amazon Aurora Not applicable. The password for the master user is managed by the DB cluster. RDS for Db2 Must contain from 8 to 255 characters. RDS for MariaDB Constraints: Must contain from 8 to 41 characters. RDS for Microsoft SQL Server Constraints: Must contain from 8 to 128 characters. RDS for MySQL Constraints: Must contain from 8 to 41 characters. RDS for Oracle Constraints: Must contain from 8 to 30 characters. RDS for PostgreSQL Constraints: Must contain from 8 to 128 characters.
- Master
User Pulumi.Secret Azure Native. Aws Connector. Inputs. Master User Secret Response - The secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide. The
MasterUserSecret
return value specifies the secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide and Password management with Secrets Manager in the Amazon Aurora User Guide. - Master
Username string - The master user name for the DB instance. If you specify the
SourceDBInstanceIdentifier
orDBSnapshotIdentifier
property, don't specify this property. The value is inherited from the source DB instance or snapshot. When migrating a self-managed Db2 database, we recommend that you use the same master username as your self-managed Db2 instance name. Amazon Aurora Not applicable. The name for the master user is managed by the DB cluster. RDS for Db2 Constraints: + Must be 1 to 16 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for MariaDB Constraints: + Must be 1 to 16 letters or numbers. + Can't be a reserved word for the chosen database engine. RDS for Microsoft SQL Server Constraints: + Must be 1 to 128 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for MySQL Constraints: + Must be 1 to 16 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for Oracle Constraints: + Must be 1 to 30 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for PostgreSQL Constraints: + Must be 1 to 63 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. - Max
Allocated intStorage - The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide. This setting doesn't apply to the following DB instances: + Amazon Aurora (Storage is managed by the DB cluster.) + RDS Custom
- Monitoring
Interval int - The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0. If
MonitoringRoleArn
is specified, then you must setMonitoringInterval
to a value other than 0. This setting doesn't apply to RDS Custom. 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 Amazon CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide. IfMonitoringInterval
is set to a value other than0
, then you must supply aMonitoringRoleArn
value. This setting doesn't apply to RDS Custom DB instances. - Multi
AZ bool - Specifies whether the database instance is a Multi-AZ DB instance deployment. You can't set the
AvailabilityZone
parameter if theMultiAZ
parameter is set to true. For more information, see Multi-AZ deployments for high availability in the Amazon RDS User Guide. Amazon Aurora Not applicable. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require theMultiAZ
option to be set. - Nchar
Character stringSet Name - The name of the NCHAR character set for the Oracle DB instance. This setting doesn't apply to RDS Custom DB instances.
- Network
Type string - The network type of the DB instance. Valid values: +
IPV4
+DUAL
The network type is determined by theDBSubnetGroup
specified for the DB instance. ADBSubnetGroup
can support only the IPv4 protocol or the IPv4 and IPv6 protocols (DUAL
). For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide. - Option
Group stringName - Indicates that the DB instance should be associated with the specified option group. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance.
- Performance
Insights stringKMSKey Id - The AWS KMS key identifier for encryption of Performance Insights data. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for
PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region. For information about enabling Performance Insights, see EnablePerformanceInsights. - Performance
Insights intRetention Period - The number of days to retain Performance Insights data. This setting doesn't apply to RDS Custom DB instances. Valid Values: +
7
+ month * 31, where month is a number of months from 1-23. Examples:93
(3 months * 31),341
(11 months * 31),589
(19 months * 31) +731
Default:7
days If you specify a retention period that isn't valid, such as94
, Amazon RDS returns an error. - Port string
- The port number on which the database accepts connections. Amazon Aurora Not applicable. The port number is managed by the DB cluster. Db2 Default value:
50000
- Preferred
Backup stringWindow - The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod
parameter. For more information, see Backup Window in the Amazon RDS User Guide. Constraints: + Must be in the formathh24:mi-hh24:mi
. + Must be in Universal Coordinated Time (UTC). + Must not conflict with the preferred maintenance window. + Must be at least 30 minutes. Amazon Aurora Not applicable. The daily time range for creating automated backups is managed by the DB cluster. - Preferred
Maintenance stringWindow - The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format:
ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window in the Amazon RDS User Guide. This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately. Constraints: Minimum 30-minute window. - Processor
Features List<Pulumi.Azure Native. Aws Connector. Inputs. Processor Feature Response> - The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
- Promotion
Tier int - The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide. This setting doesn't apply to RDS Custom DB instances. Default:
1
Valid Values:0 - 15
- Publicly
Accessible bool - Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address. The default behavior value depends on your VPC setup and the database subnet group. For more information, see the
PubliclyAccessible
parameter in the CreateDBInstance in the Amazon RDS API Reference. - Replica
Mode string - The open mode of an Oracle read replica. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide. This setting is only supported in RDS for Oracle. Default:
open-read-only
Valid Values:open-read-only
ormounted
- Restore
Time string - The date and time to restore from. Constraints: + Must be a time in Universal Coordinated Time (UTC) format. + Must be before the latest restorable time for the DB instance. + Can't be specified if the
UseLatestRestorableTime
parameter is enabled. Example:2009-09-07T23:45:00Z
- Source
DBCluster stringIdentifier - The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas. Constraints: + Must be the identifier of an existing Multi-AZ DB cluster. + Can't be specified if the
SourceDBInstanceIdentifier
parameter is also specified. + The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0. + The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported. - Source
DBInstance stringAutomated Backups Arn - The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example,
arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE
. This setting doesn't apply to RDS Custom. - Source
DBInstance stringIdentifier - If you want to create a read replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of read replicas. For more information, see Working with Read Replicas in the Amazon RDS User Guide. For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide. The
SourceDBInstanceIdentifier
property determines whether a DB instance is a read replica. If you remove theSourceDBInstanceIdentifier
property from your template and then update your stack, AWS CloudFormation promotes the Read Replica to a standalone DB instance. + If you specify a source DB instance that uses VPC security groups, we recommend that you specify theVPCSecurityGroups
property. If you don't specify the property, the read replica inherits the value of theVPCSecurityGroups
property from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica'sVPCSecurityGroups
property to the default value because it's not defined in the stack's template. This change might cause unexpected issues. + Read replicas don't support deletion policies. AWS CloudFormation ignores any deletion policy that's associated with a read replica. + If you specifySourceDBInstanceIdentifier
, don't specify theDBSnapshotIdentifier
property. You can't create a read replica from a snapshot. + Don't set theBackupRetentionPeriod
,DBName
,MasterUsername
,MasterUserPassword
, andPreferredBackupWindow
properties. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas. + If the source DB instance is in a different region than the read replica, specify the source region inSourceRegion
, and specify an ARN for a valid DB instance inSourceDBInstanceIdentifier
. For more information, see Constructing a Amazon RDS Amazon Resource Name (ARN) in the Amazon RDS User Guide. + For DB instances in Amazon Aurora clusters, don't specify this property. Amazon RDS automatically assigns writer and reader DB instances. - Source
Dbi stringResource Id - The resource ID of the source DB instance from which to restore.
- Source
Region string - The ID of the region that contains the source DB instance for the read replica.
- Storage
Encrypted bool - A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. If you specify the
KmsKeyId
property, then you must enable encryption. If you specify theSourceDBInstanceIdentifier
property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specifiedKmsKeyId
property is used. If you specify theDBSnapshotIdentifier
and the specified snapshot is encrypted, don't specify this property. The value is inherited from the snapshot, and the specifiedKmsKeyId
property is used. If you specify theDBSnapshotIdentifier
and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB instance is encrypted. Specify theKmsKeyId
property for the KMS key to use for encryption. If you don't want the restored DB instance to be encrypted, then don't set this property or set it tofalse
. Amazon Aurora Not applicable. The encryption for DB instances is managed by the DB cluster. - Storage
Throughput int - Specifies the storage throughput value for the DB instance. This setting applies only to the
gp3
storage type. This setting doesn't apply to RDS Custom or Amazon Aurora. - Storage
Type string - The storage type to associate with the DB instance. If you specify
io1
,io2
, orgp3
, you must also include a value for theIops
parameter. This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster. Valid Values:gp2 | gp3 | io1 | io2 | standard
Default:io1
, if theIops
parameter is specified. Otherwise,gp2
. - List<Pulumi.
Azure Native. Aws Connector. Inputs. Tag Response> - An optional array of key-value pairs to apply to this DB instance.
- Tde
Credential stringArn - Property tdeCredentialArn
- Tde
Credential stringPassword - Property tdeCredentialPassword
- Timezone string
- The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.
- Use
Default boolProcessor Features - Specifies whether the DB instance class of the DB instance uses its default processor features. This setting doesn't apply to RDS Custom DB instances.
- Use
Latest boolRestorable Time - Specifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time. Constraints: + Can't be specified if the
RestoreTime
parameter is provided. - Vpc
Security List<string>Groups - A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to AWS::EC2::SecurityGroup resources created in the template. If you plan to update the resource, don't specify VPC security groups in a shared VPC. If you set
VPCSecurityGroups
, you must not set DBSecurityGroups, and vice versa. You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind: + You can't revert to using an RDS security group after you establish a VPC security group membership. + When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group. + To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the DBSecurityGroups property. To avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template. Amazon Aurora Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
- Allocated
Storage string - The amount of storage in gibibytes (GiB) to be initially allocated for the database instance. If any value is set in the
Iops
parameter,AllocatedStorage
must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase theIops
value (in 1,000 IOPS increments), then you must also increase theAllocatedStorage
value (in 100-GiB increments). Amazon Aurora Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume. Db2 Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000. + Provisioned IOPS storage (io1): Must be an integer from 100 to 64000. MySQL Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. MariaDB Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. PostgreSQL Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. Oracle Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 10 to 3072. SQL Server Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): + Enterprise and Standard editions: Must be an integer from 20 to 16384. + Web and Express editions: Must be an integer from 20 to 16384. + Provisioned IOPS storage (io1): + Enterprise and Standard editions: Must be an integer from 20 to 16384. + Web and Express editions: Must be an integer from 20 to 16384. + Magnetic storage (standard): + Enterprise and Standard editions: Must be an integer from 20 to 1024. + Web and Express editions: Must be an integer from 20 to 1024. - Allow
Major boolVersion Upgrade - A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Constraints: Major version upgrades must be allowed when specifying a value for the
EngineVersion
parameter that is a different major version than the DB instance's current version. - Associated
Roles []DBInstanceRole Response - The IAMlong (IAM) roles associated with the DB instance. Amazon Aurora Not applicable. The associated roles are managed by the DB cluster.
- Auto
Minor boolVersion Upgrade - A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.
- Automatic
Backup stringReplication Kms Key Id - Property automaticBackupReplicationKmsKeyId
- Automatic
Backup stringReplication Region - The destination region for the backup replication of the DB instance. For more info, see Replicating automated backups to another Region in the Amazon RDS User Guide.
- Availability
Zone string - The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see Regions and Availability Zones. For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one. Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region. Constraints: + The
AvailabilityZone
parameter can't be specified if the DB instance is a Multi-AZ deployment. + The specified Availability Zone must be in the same AWS-Region as the current endpoint. Example:us-east-1d
- Backup
Retention intPeriod - The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Amazon Aurora Not applicable. The retention period for automated backups is managed by the DB cluster. Default: 1 Constraints: + Must be a value from 0 to 35 + Can't be set to 0 if the DB instance is a source to read replicas
- Ca
Certificate stringIdentifier - The identifier of the CA certificate for this DB instance. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- Certificate
Details CertificateDetails Response - The details of the DB instance's server certificate. Returns the details of the DB instance’s server certificate. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- Certificate
Rotation boolRestart - Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate. By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. Set this parameter only if you are not using SSL/TLS to connect to the DB instance. If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate: + For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide. + For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide. This setting doesn't apply to RDS Custom DB instances.
- Character
Set stringName - For supported engines, indicates that the DB instance should be associated with the specified character set. Amazon Aurora Not applicable. The character set is managed by the DB cluster. For more information, see AWS::RDS::DBCluster.
- bool
- Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
- Custom
IAMInstance stringProfile - The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. This setting is required for RDS Custom. Constraints: + The profile must exist in your account. + The profile must have an IAM role that Amazon EC2 has permissions to assume. + The instance profile name and the associated IAM role name must start with the prefix
AWSRDSCustom
. For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide. - Db
Cluster stringIdentifier - The identifier of the DB cluster that the instance will belong to.
- Db
Cluster stringSnapshot Identifier - The identifier for the Multi-AZ DB cluster snapshot to restore from. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide. Constraints: + Must match the identifier of an existing Multi-AZ DB cluster snapshot. + Can't be specified when
DBSnapshotIdentifier
is specified. + Must be specified whenDBSnapshotIdentifier
isn't specified. + If you are restoring from a shared manual Multi-AZ DB cluster snapshot, theDBClusterSnapshotIdentifier
must be the ARN of the shared snapshot. + Can't be the identifier of an Aurora DB cluster snapshot. - Db
Instance stringArn - Property dbInstanceArn
- Db
Instance stringClass - The compute and memory capacity of the DB instance, for example
db.m5.large
. Not all DB instance classes are available in all AWS-Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB instance classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide. - Db
Instance stringIdentifier - A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see Name Type. For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
- Db
Name string - The meaning of this parameter differs according to the database engine you use. If you specify the
DBSnapshotIdentifier
property, this property only applies to RDS for Oracle. Amazon Aurora Not applicable. The database name is managed by the DB cluster. Db2 The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. Constraints: + Must contain 1 to 64 letters or numbers. + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + Can't be a word reserved by the specified database engine. MySQL 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. Constraints: + Must contain 1 to 64 letters or numbers. + Can't be a word reserved by the specified database engine MariaDB 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. Constraints: + Must contain 1 to 64 letters or numbers. + Can't be a word reserved by the specified database engine PostgreSQL The name of the database to create when the DB instance is created. If this parameter is not specified, the defaultpostgres
database is created in the DB instance. Constraints: + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + Must contain 1 to 63 characters. + Can't be a word reserved by the specified database engine Oracle The Oracle System ID (SID) of the created DB instance. If you specifynull
, the default valueORCL
is used. You can't specify the string NULL, or any other reserved word, forDBName
. Default:ORCL
Constraints: + Can't be longer than 8 characters SQL Server Not applicable. Must be null. - Db
Parameter stringGroup Name - The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template. To list all of the available DB parameter group names, use the following command:
aws rds describe-db-parameter-groups --query 'DBParameterGroups[].DBParameterGroupName' --output text
If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot. If you don't specify a value forDBParameterGroupName
property, the default DB parameter group for the specified engine and engine version is used. - Db
Security []stringGroups - A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template. If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups. If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations: +
AllocatedStorage
+AutoMinorVersionUpgrade
+AvailabilityZone
+BackupRetentionPeriod
+CharacterSetName
+DBInstanceClass
+DBName
+DBParameterGroupName
+DBSecurityGroups
+DBSubnetGroupName
+Engine
+EngineVersion
+Iops
+LicenseModel
+MasterUsername
+MasterUserPassword
+MultiAZ
+OptionGroupName
+PreferredBackupWindow
+PreferredMaintenanceWindow
All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such asStorageType
,StorageEncrypted
, orKmsKeyId
. If you're already using theDBSecurityGroups
property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance. - Db
Snapshot stringIdentifier - The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot. By specifying this property, you can create a DB instance from the specified DB snapshot. If the
DBSnapshotIdentifier
property is an empty string or theAWS::RDS::DBInstance
declaration has noDBSnapshotIdentifier
property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack. Some DB instance properties aren't valid when you restore from a snapshot, such as theMasterUsername
andMasterUserPassword
properties. For information about the properties that you can specify, see theRestoreDBInstanceFromDBSnapshot
action in the Amazon RDS API Reference. After you restore a DB instance with aDBSnapshotIdentifier
property, you must specify the sameDBSnapshotIdentifier
property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify theDBSnapshotIdentifier
property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specifiedDBSnapshotIdentifier
property, and the original DB instance is deleted. If you specify theDBSnapshotIdentifier
property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties: +CharacterSetName
+DBClusterIdentifier
+DBName
+DeleteAutomatedBackups
+EnablePerformanceInsights
+KmsKeyId
+MasterUsername
+MasterUserPassword
+PerformanceInsightsKMSKeyId
+PerformanceInsightsRetentionPeriod
+PromotionTier
+SourceDBInstanceIdentifier
+SourceRegion
+StorageEncrypted
(for an encrypted snapshot) +Timezone
Amazon Aurora Not applicable. Snapshot restore is managed by the DB cluster. - Db
Subnet stringGroup Name - A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC. If there's no DB subnet group, then the DB instance isn't a VPC DB instance. For more information about using Amazon RDS in a VPC, see Using Amazon RDS with Amazon Virtual Private Cloud (VPC) in the Amazon RDS User Guide. Amazon Aurora Not applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
- Db
System stringId - The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term 'Oracle database instance' refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to
RDSCDB
. The Oracle SID is also the name of your CDB. - Dbi
Resource stringId - Property dbiResourceId
- Dedicated
Log boolVolume - Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
- Delete
Automated boolBackups - A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted. Amazon Aurora Not applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted.
- Deletion
Protection bool - A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance. Amazon Aurora Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see
CreateDBCluster
. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster. - Domain string
- The Active Directory directory ID to create the DB instance in. Currently, only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see Kerberos Authentication in the Amazon RDS User Guide.
- Domain
Auth stringSecret Arn - The ARN for the Secrets Manager secret with the credentials for the user joining the domain. Example:
arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
- Domain
Dns []stringIps - The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers. Constraints: + 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. Example:
123.124.125.126,234.235.236.237
- Domain
Fqdn string - The fully qualified domain name (FQDN) of an Active Directory domain. Constraints: + Can't be longer than 64 characters. Example:
mymanagedADtest.mymanagedAD.mydomain
- Domain
IAMRole stringName - The name of the IAM role to use when making API calls to the Directory Service. This setting doesn't apply to the following DB instances: + Amazon Aurora (The domain is managed by the DB cluster.) + RDS Custom
- Domain
Ou string - The Active Directory organizational unit for your DB instance to join. Constraints: + Must be in the distinguished name format. + Can't be longer than 64 characters. Example:
OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
- Enable
Cloudwatch []stringLogs Exports - The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service User Guide. Amazon Aurora Not applicable. CloudWatch Logs exports are managed by the DB cluster. Db2 Valid values:
diag.log
,notify.log
MariaDB Valid values:audit
,error
,general
,slowquery
Microsoft SQL Server Valid values:agent
,error
MySQL Valid values:audit
,error
,general
,slowquery
Oracle Valid values:alert
,audit
,listener
,trace
,oemagent
PostgreSQL Valid values:postgresql
,upgrade
- Enable
IAMDatabase boolAuthentication - A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see IAM Database Authentication for MariaDB, MySQL, and PostgreSQL in the Amazon RDS User Guide. Amazon Aurora Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
- Enable
Performance boolInsights - Specifies whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom DB instances.
- Endpoint
Rds
Db Instance Endpoint Response - The connection endpoint for the DB instance. The endpoint might not be shown for instances with the status of
creating
. This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions: +CreateDBInstance
+DescribeDBInstances
+DeleteDBInstance
For the data structure that represents Amazon Aurora DB cluster endpoints, seeDBClusterEndpoint
. - Engine string
- The name of the database engine to use for this DB instance. Not every database engine is available in every AWS Region. This property is required when creating a DB instance. You can change the architecture of an Oracle database from the non-container database (CDB) architecture to the CDB architecture by updating the
Engine
value in your templates fromoracle-ee
ororacle-ee-cdb
tooracle-se2-cdb
. Converting to the CDB architecture requires an interruption. Valid Values: +aurora-mysql
(for Aurora MySQL DB instances) +aurora-postgresql
(for Aurora PostgreSQL DB instances) +custom-oracle-ee
(for RDS Custom for Oracle DB instances) +custom-oracle-ee-cdb
(for RDS Custom for Oracle DB instances) +custom-sqlserver-ee
(for RDS Custom for SQL Server DB instances) +custom-sqlserver-se
(for RDS Custom for SQL Server DB instances) +custom-sqlserver-web
(for RDS Custom for SQL Server DB instances) +db2-ae
+db2-se
+mariadb
+mysql
+oracle-ee
+oracle-ee-cdb
+oracle-se2
+oracle-se2-cdb
+postgres
+sqlserver-ee
+sqlserver-se
+sqlserver-ex
+sqlserver-web
- Engine
Version string - The version number of the database engine to use. For a list of valid engine versions, use the
DescribeDBEngineVersions
action. The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region. Amazon Aurora Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. Db2 See Amazon RDS for Db2 in the Amazon RDS User Guide. MariaDB See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide. Microsoft SQL Server See Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide. MySQL See MySQL on Amazon RDS Versions in the Amazon RDS User Guide. Oracle See Oracle Database Engine Release Notes in the Amazon RDS User Guide. PostgreSQL See Supported PostgreSQL Database Versions in the Amazon RDS User Guide. - Iops int
- The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide. If you specify
io1
for theStorageType
property, then you must also specify theIops
property. Constraints: + For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance. + For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance. - Kms
Key stringId - The ARN of the AWS KMS key that's used to encrypt the DB instance, such as
arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef
. If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default KMS key. If you specify this property, you must set the StorageEncrypted property to true. If you specify theSourceDBInstanceIdentifier
property, the value is inherited from the source DB instance if the read replica is created in the same region. If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region. If you specify theSnapshotIdentifier
property, theStorageEncrypted
property value is inherited from the snapshot, and if the DB instance is encrypted, the specifiedKmsKeyId
property is used. If you specifyDBSecurityGroups
, AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see Using Amazon RDS with Amazon VPC in the Amazon RDS User Guide. Amazon Aurora Not applicable. The KMS key identifier is managed by the DB cluster. - License
Model string - License model information for this DB instance. Valid Values: + Aurora MySQL -
general-public-license
+ Aurora PostgreSQL -postgresql-license
+ RDS for Db2 -bring-your-own-license
. For more information about RDS for Db2 licensing, see in the Amazon RDS User Guide. + 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
orlicense-included
+ RDS for PostgreSQL -postgresql-license
If you've specifiedDBSecurityGroups
and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability. - Manage
Master boolUser Password - Specifies whether to manage the master user password with AWS Secrets Manager. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide. Constraints: + Can't manage the master user password with AWS Secrets Manager if
MasterUserPassword
is specified. - Master
User stringPassword - The password for the master user. The password can include any printable ASCII character except '/', ''', or '@'. Amazon Aurora Not applicable. The password for the master user is managed by the DB cluster. RDS for Db2 Must contain from 8 to 255 characters. RDS for MariaDB Constraints: Must contain from 8 to 41 characters. RDS for Microsoft SQL Server Constraints: Must contain from 8 to 128 characters. RDS for MySQL Constraints: Must contain from 8 to 41 characters. RDS for Oracle Constraints: Must contain from 8 to 30 characters. RDS for PostgreSQL Constraints: Must contain from 8 to 128 characters.
- Master
User MasterSecret User Secret Response - The secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide. The
MasterUserSecret
return value specifies the secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide and Password management with Secrets Manager in the Amazon Aurora User Guide. - Master
Username string - The master user name for the DB instance. If you specify the
SourceDBInstanceIdentifier
orDBSnapshotIdentifier
property, don't specify this property. The value is inherited from the source DB instance or snapshot. When migrating a self-managed Db2 database, we recommend that you use the same master username as your self-managed Db2 instance name. Amazon Aurora Not applicable. The name for the master user is managed by the DB cluster. RDS for Db2 Constraints: + Must be 1 to 16 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for MariaDB Constraints: + Must be 1 to 16 letters or numbers. + Can't be a reserved word for the chosen database engine. RDS for Microsoft SQL Server Constraints: + Must be 1 to 128 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for MySQL Constraints: + Must be 1 to 16 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for Oracle Constraints: + Must be 1 to 30 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for PostgreSQL Constraints: + Must be 1 to 63 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. - Max
Allocated intStorage - The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide. This setting doesn't apply to the following DB instances: + Amazon Aurora (Storage is managed by the DB cluster.) + RDS Custom
- Monitoring
Interval int - The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0. If
MonitoringRoleArn
is specified, then you must setMonitoringInterval
to a value other than 0. This setting doesn't apply to RDS Custom. 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 Amazon CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide. IfMonitoringInterval
is set to a value other than0
, then you must supply aMonitoringRoleArn
value. This setting doesn't apply to RDS Custom DB instances. - Multi
AZ bool - Specifies whether the database instance is a Multi-AZ DB instance deployment. You can't set the
AvailabilityZone
parameter if theMultiAZ
parameter is set to true. For more information, see Multi-AZ deployments for high availability in the Amazon RDS User Guide. Amazon Aurora Not applicable. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require theMultiAZ
option to be set. - Nchar
Character stringSet Name - The name of the NCHAR character set for the Oracle DB instance. This setting doesn't apply to RDS Custom DB instances.
- Network
Type string - The network type of the DB instance. Valid values: +
IPV4
+DUAL
The network type is determined by theDBSubnetGroup
specified for the DB instance. ADBSubnetGroup
can support only the IPv4 protocol or the IPv4 and IPv6 protocols (DUAL
). For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide. - Option
Group stringName - Indicates that the DB instance should be associated with the specified option group. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance.
- Performance
Insights stringKMSKey Id - The AWS KMS key identifier for encryption of Performance Insights data. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for
PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region. For information about enabling Performance Insights, see EnablePerformanceInsights. - Performance
Insights intRetention Period - The number of days to retain Performance Insights data. This setting doesn't apply to RDS Custom DB instances. Valid Values: +
7
+ month * 31, where month is a number of months from 1-23. Examples:93
(3 months * 31),341
(11 months * 31),589
(19 months * 31) +731
Default:7
days If you specify a retention period that isn't valid, such as94
, Amazon RDS returns an error. - Port string
- The port number on which the database accepts connections. Amazon Aurora Not applicable. The port number is managed by the DB cluster. Db2 Default value:
50000
- Preferred
Backup stringWindow - The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod
parameter. For more information, see Backup Window in the Amazon RDS User Guide. Constraints: + Must be in the formathh24:mi-hh24:mi
. + Must be in Universal Coordinated Time (UTC). + Must not conflict with the preferred maintenance window. + Must be at least 30 minutes. Amazon Aurora Not applicable. The daily time range for creating automated backups is managed by the DB cluster. - Preferred
Maintenance stringWindow - The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format:
ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window in the Amazon RDS User Guide. This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately. Constraints: Minimum 30-minute window. - Processor
Features []ProcessorFeature Response - The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
- Promotion
Tier int - The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide. This setting doesn't apply to RDS Custom DB instances. Default:
1
Valid Values:0 - 15
- Publicly
Accessible bool - Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address. The default behavior value depends on your VPC setup and the database subnet group. For more information, see the
PubliclyAccessible
parameter in the CreateDBInstance in the Amazon RDS API Reference. - Replica
Mode string - The open mode of an Oracle read replica. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide. This setting is only supported in RDS for Oracle. Default:
open-read-only
Valid Values:open-read-only
ormounted
- Restore
Time string - The date and time to restore from. Constraints: + Must be a time in Universal Coordinated Time (UTC) format. + Must be before the latest restorable time for the DB instance. + Can't be specified if the
UseLatestRestorableTime
parameter is enabled. Example:2009-09-07T23:45:00Z
- Source
DBCluster stringIdentifier - The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas. Constraints: + Must be the identifier of an existing Multi-AZ DB cluster. + Can't be specified if the
SourceDBInstanceIdentifier
parameter is also specified. + The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0. + The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported. - Source
DBInstance stringAutomated Backups Arn - The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example,
arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE
. This setting doesn't apply to RDS Custom. - Source
DBInstance stringIdentifier - If you want to create a read replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of read replicas. For more information, see Working with Read Replicas in the Amazon RDS User Guide. For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide. The
SourceDBInstanceIdentifier
property determines whether a DB instance is a read replica. If you remove theSourceDBInstanceIdentifier
property from your template and then update your stack, AWS CloudFormation promotes the Read Replica to a standalone DB instance. + If you specify a source DB instance that uses VPC security groups, we recommend that you specify theVPCSecurityGroups
property. If you don't specify the property, the read replica inherits the value of theVPCSecurityGroups
property from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica'sVPCSecurityGroups
property to the default value because it's not defined in the stack's template. This change might cause unexpected issues. + Read replicas don't support deletion policies. AWS CloudFormation ignores any deletion policy that's associated with a read replica. + If you specifySourceDBInstanceIdentifier
, don't specify theDBSnapshotIdentifier
property. You can't create a read replica from a snapshot. + Don't set theBackupRetentionPeriod
,DBName
,MasterUsername
,MasterUserPassword
, andPreferredBackupWindow
properties. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas. + If the source DB instance is in a different region than the read replica, specify the source region inSourceRegion
, and specify an ARN for a valid DB instance inSourceDBInstanceIdentifier
. For more information, see Constructing a Amazon RDS Amazon Resource Name (ARN) in the Amazon RDS User Guide. + For DB instances in Amazon Aurora clusters, don't specify this property. Amazon RDS automatically assigns writer and reader DB instances. - Source
Dbi stringResource Id - The resource ID of the source DB instance from which to restore.
- Source
Region string - The ID of the region that contains the source DB instance for the read replica.
- Storage
Encrypted bool - A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. If you specify the
KmsKeyId
property, then you must enable encryption. If you specify theSourceDBInstanceIdentifier
property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specifiedKmsKeyId
property is used. If you specify theDBSnapshotIdentifier
and the specified snapshot is encrypted, don't specify this property. The value is inherited from the snapshot, and the specifiedKmsKeyId
property is used. If you specify theDBSnapshotIdentifier
and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB instance is encrypted. Specify theKmsKeyId
property for the KMS key to use for encryption. If you don't want the restored DB instance to be encrypted, then don't set this property or set it tofalse
. Amazon Aurora Not applicable. The encryption for DB instances is managed by the DB cluster. - Storage
Throughput int - Specifies the storage throughput value for the DB instance. This setting applies only to the
gp3
storage type. This setting doesn't apply to RDS Custom or Amazon Aurora. - Storage
Type string - The storage type to associate with the DB instance. If you specify
io1
,io2
, orgp3
, you must also include a value for theIops
parameter. This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster. Valid Values:gp2 | gp3 | io1 | io2 | standard
Default:io1
, if theIops
parameter is specified. Otherwise,gp2
. - []Tag
Response - An optional array of key-value pairs to apply to this DB instance.
- Tde
Credential stringArn - Property tdeCredentialArn
- Tde
Credential stringPassword - Property tdeCredentialPassword
- Timezone string
- The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.
- Use
Default boolProcessor Features - Specifies whether the DB instance class of the DB instance uses its default processor features. This setting doesn't apply to RDS Custom DB instances.
- Use
Latest boolRestorable Time - Specifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time. Constraints: + Can't be specified if the
RestoreTime
parameter is provided. - Vpc
Security []stringGroups - A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to AWS::EC2::SecurityGroup resources created in the template. If you plan to update the resource, don't specify VPC security groups in a shared VPC. If you set
VPCSecurityGroups
, you must not set DBSecurityGroups, and vice versa. You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind: + You can't revert to using an RDS security group after you establish a VPC security group membership. + When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group. + To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the DBSecurityGroups property. To avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template. Amazon Aurora Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
- allocated
Storage String - The amount of storage in gibibytes (GiB) to be initially allocated for the database instance. If any value is set in the
Iops
parameter,AllocatedStorage
must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase theIops
value (in 1,000 IOPS increments), then you must also increase theAllocatedStorage
value (in 100-GiB increments). Amazon Aurora Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume. Db2 Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000. + Provisioned IOPS storage (io1): Must be an integer from 100 to 64000. MySQL Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. MariaDB Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. PostgreSQL Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. Oracle Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 10 to 3072. SQL Server Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): + Enterprise and Standard editions: Must be an integer from 20 to 16384. + Web and Express editions: Must be an integer from 20 to 16384. + Provisioned IOPS storage (io1): + Enterprise and Standard editions: Must be an integer from 20 to 16384. + Web and Express editions: Must be an integer from 20 to 16384. + Magnetic storage (standard): + Enterprise and Standard editions: Must be an integer from 20 to 1024. + Web and Express editions: Must be an integer from 20 to 1024. - allow
Major BooleanVersion Upgrade - A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Constraints: Major version upgrades must be allowed when specifying a value for the
EngineVersion
parameter that is a different major version than the DB instance's current version. - associated
Roles List<DBInstanceRole Response> - The IAMlong (IAM) roles associated with the DB instance. Amazon Aurora Not applicable. The associated roles are managed by the DB cluster.
- auto
Minor BooleanVersion Upgrade - A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.
- automatic
Backup StringReplication Kms Key Id - Property automaticBackupReplicationKmsKeyId
- automatic
Backup StringReplication Region - The destination region for the backup replication of the DB instance. For more info, see Replicating automated backups to another Region in the Amazon RDS User Guide.
- availability
Zone String - The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see Regions and Availability Zones. For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one. Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region. Constraints: + The
AvailabilityZone
parameter can't be specified if the DB instance is a Multi-AZ deployment. + The specified Availability Zone must be in the same AWS-Region as the current endpoint. Example:us-east-1d
- backup
Retention IntegerPeriod - The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Amazon Aurora Not applicable. The retention period for automated backups is managed by the DB cluster. Default: 1 Constraints: + Must be a value from 0 to 35 + Can't be set to 0 if the DB instance is a source to read replicas
- ca
Certificate StringIdentifier - The identifier of the CA certificate for this DB instance. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- certificate
Details CertificateDetails Response - The details of the DB instance's server certificate. Returns the details of the DB instance’s server certificate. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- certificate
Rotation BooleanRestart - Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate. By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. Set this parameter only if you are not using SSL/TLS to connect to the DB instance. If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate: + For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide. + For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide. This setting doesn't apply to RDS Custom DB instances.
- character
Set StringName - For supported engines, indicates that the DB instance should be associated with the specified character set. Amazon Aurora Not applicable. The character set is managed by the DB cluster. For more information, see AWS::RDS::DBCluster.
- Boolean
- Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
- custom
IAMInstance StringProfile - The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. This setting is required for RDS Custom. Constraints: + The profile must exist in your account. + The profile must have an IAM role that Amazon EC2 has permissions to assume. + The instance profile name and the associated IAM role name must start with the prefix
AWSRDSCustom
. For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide. - db
Cluster StringIdentifier - The identifier of the DB cluster that the instance will belong to.
- db
Cluster StringSnapshot Identifier - The identifier for the Multi-AZ DB cluster snapshot to restore from. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide. Constraints: + Must match the identifier of an existing Multi-AZ DB cluster snapshot. + Can't be specified when
DBSnapshotIdentifier
is specified. + Must be specified whenDBSnapshotIdentifier
isn't specified. + If you are restoring from a shared manual Multi-AZ DB cluster snapshot, theDBClusterSnapshotIdentifier
must be the ARN of the shared snapshot. + Can't be the identifier of an Aurora DB cluster snapshot. - db
Instance StringArn - Property dbInstanceArn
- db
Instance StringClass - The compute and memory capacity of the DB instance, for example
db.m5.large
. Not all DB instance classes are available in all AWS-Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB instance classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide. - db
Instance StringIdentifier - A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see Name Type. For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
- db
Name String - The meaning of this parameter differs according to the database engine you use. If you specify the
DBSnapshotIdentifier
property, this property only applies to RDS for Oracle. Amazon Aurora Not applicable. The database name is managed by the DB cluster. Db2 The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. Constraints: + Must contain 1 to 64 letters or numbers. + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + Can't be a word reserved by the specified database engine. MySQL 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. Constraints: + Must contain 1 to 64 letters or numbers. + Can't be a word reserved by the specified database engine MariaDB 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. Constraints: + Must contain 1 to 64 letters or numbers. + Can't be a word reserved by the specified database engine PostgreSQL The name of the database to create when the DB instance is created. If this parameter is not specified, the defaultpostgres
database is created in the DB instance. Constraints: + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + Must contain 1 to 63 characters. + Can't be a word reserved by the specified database engine Oracle The Oracle System ID (SID) of the created DB instance. If you specifynull
, the default valueORCL
is used. You can't specify the string NULL, or any other reserved word, forDBName
. Default:ORCL
Constraints: + Can't be longer than 8 characters SQL Server Not applicable. Must be null. - db
Parameter StringGroup Name - The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template. To list all of the available DB parameter group names, use the following command:
aws rds describe-db-parameter-groups --query 'DBParameterGroups[].DBParameterGroupName' --output text
If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot. If you don't specify a value forDBParameterGroupName
property, the default DB parameter group for the specified engine and engine version is used. - db
Security List<String>Groups - A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template. If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups. If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations: +
AllocatedStorage
+AutoMinorVersionUpgrade
+AvailabilityZone
+BackupRetentionPeriod
+CharacterSetName
+DBInstanceClass
+DBName
+DBParameterGroupName
+DBSecurityGroups
+DBSubnetGroupName
+Engine
+EngineVersion
+Iops
+LicenseModel
+MasterUsername
+MasterUserPassword
+MultiAZ
+OptionGroupName
+PreferredBackupWindow
+PreferredMaintenanceWindow
All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such asStorageType
,StorageEncrypted
, orKmsKeyId
. If you're already using theDBSecurityGroups
property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance. - db
Snapshot StringIdentifier - The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot. By specifying this property, you can create a DB instance from the specified DB snapshot. If the
DBSnapshotIdentifier
property is an empty string or theAWS::RDS::DBInstance
declaration has noDBSnapshotIdentifier
property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack. Some DB instance properties aren't valid when you restore from a snapshot, such as theMasterUsername
andMasterUserPassword
properties. For information about the properties that you can specify, see theRestoreDBInstanceFromDBSnapshot
action in the Amazon RDS API Reference. After you restore a DB instance with aDBSnapshotIdentifier
property, you must specify the sameDBSnapshotIdentifier
property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify theDBSnapshotIdentifier
property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specifiedDBSnapshotIdentifier
property, and the original DB instance is deleted. If you specify theDBSnapshotIdentifier
property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties: +CharacterSetName
+DBClusterIdentifier
+DBName
+DeleteAutomatedBackups
+EnablePerformanceInsights
+KmsKeyId
+MasterUsername
+MasterUserPassword
+PerformanceInsightsKMSKeyId
+PerformanceInsightsRetentionPeriod
+PromotionTier
+SourceDBInstanceIdentifier
+SourceRegion
+StorageEncrypted
(for an encrypted snapshot) +Timezone
Amazon Aurora Not applicable. Snapshot restore is managed by the DB cluster. - db
Subnet StringGroup Name - A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC. If there's no DB subnet group, then the DB instance isn't a VPC DB instance. For more information about using Amazon RDS in a VPC, see Using Amazon RDS with Amazon Virtual Private Cloud (VPC) in the Amazon RDS User Guide. Amazon Aurora Not applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
- db
System StringId - The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term 'Oracle database instance' refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to
RDSCDB
. The Oracle SID is also the name of your CDB. - dbi
Resource StringId - Property dbiResourceId
- dedicated
Log BooleanVolume - Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
- delete
Automated BooleanBackups - A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted. Amazon Aurora Not applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted.
- deletion
Protection Boolean - A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance. Amazon Aurora Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see
CreateDBCluster
. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster. - domain String
- The Active Directory directory ID to create the DB instance in. Currently, only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see Kerberos Authentication in the Amazon RDS User Guide.
- domain
Auth StringSecret Arn - The ARN for the Secrets Manager secret with the credentials for the user joining the domain. Example:
arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
- domain
Dns List<String>Ips - The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers. Constraints: + 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. Example:
123.124.125.126,234.235.236.237
- domain
Fqdn String - The fully qualified domain name (FQDN) of an Active Directory domain. Constraints: + Can't be longer than 64 characters. Example:
mymanagedADtest.mymanagedAD.mydomain
- domain
IAMRole StringName - The name of the IAM role to use when making API calls to the Directory Service. This setting doesn't apply to the following DB instances: + Amazon Aurora (The domain is managed by the DB cluster.) + RDS Custom
- domain
Ou String - The Active Directory organizational unit for your DB instance to join. Constraints: + Must be in the distinguished name format. + Can't be longer than 64 characters. Example:
OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
- enable
Cloudwatch List<String>Logs Exports - The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service User Guide. Amazon Aurora Not applicable. CloudWatch Logs exports are managed by the DB cluster. Db2 Valid values:
diag.log
,notify.log
MariaDB Valid values:audit
,error
,general
,slowquery
Microsoft SQL Server Valid values:agent
,error
MySQL Valid values:audit
,error
,general
,slowquery
Oracle Valid values:alert
,audit
,listener
,trace
,oemagent
PostgreSQL Valid values:postgresql
,upgrade
- enable
IAMDatabase BooleanAuthentication - A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see IAM Database Authentication for MariaDB, MySQL, and PostgreSQL in the Amazon RDS User Guide. Amazon Aurora Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
- enable
Performance BooleanInsights - Specifies whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom DB instances.
- endpoint
Rds
Db Instance Endpoint Response - The connection endpoint for the DB instance. The endpoint might not be shown for instances with the status of
creating
. This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions: +CreateDBInstance
+DescribeDBInstances
+DeleteDBInstance
For the data structure that represents Amazon Aurora DB cluster endpoints, seeDBClusterEndpoint
. - engine String
- The name of the database engine to use for this DB instance. Not every database engine is available in every AWS Region. This property is required when creating a DB instance. You can change the architecture of an Oracle database from the non-container database (CDB) architecture to the CDB architecture by updating the
Engine
value in your templates fromoracle-ee
ororacle-ee-cdb
tooracle-se2-cdb
. Converting to the CDB architecture requires an interruption. Valid Values: +aurora-mysql
(for Aurora MySQL DB instances) +aurora-postgresql
(for Aurora PostgreSQL DB instances) +custom-oracle-ee
(for RDS Custom for Oracle DB instances) +custom-oracle-ee-cdb
(for RDS Custom for Oracle DB instances) +custom-sqlserver-ee
(for RDS Custom for SQL Server DB instances) +custom-sqlserver-se
(for RDS Custom for SQL Server DB instances) +custom-sqlserver-web
(for RDS Custom for SQL Server DB instances) +db2-ae
+db2-se
+mariadb
+mysql
+oracle-ee
+oracle-ee-cdb
+oracle-se2
+oracle-se2-cdb
+postgres
+sqlserver-ee
+sqlserver-se
+sqlserver-ex
+sqlserver-web
- engine
Version String - The version number of the database engine to use. For a list of valid engine versions, use the
DescribeDBEngineVersions
action. The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region. Amazon Aurora Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. Db2 See Amazon RDS for Db2 in the Amazon RDS User Guide. MariaDB See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide. Microsoft SQL Server See Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide. MySQL See MySQL on Amazon RDS Versions in the Amazon RDS User Guide. Oracle See Oracle Database Engine Release Notes in the Amazon RDS User Guide. PostgreSQL See Supported PostgreSQL Database Versions in the Amazon RDS User Guide. - iops Integer
- The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide. If you specify
io1
for theStorageType
property, then you must also specify theIops
property. Constraints: + For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance. + For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance. - kms
Key StringId - The ARN of the AWS KMS key that's used to encrypt the DB instance, such as
arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef
. If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default KMS key. If you specify this property, you must set the StorageEncrypted property to true. If you specify theSourceDBInstanceIdentifier
property, the value is inherited from the source DB instance if the read replica is created in the same region. If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region. If you specify theSnapshotIdentifier
property, theStorageEncrypted
property value is inherited from the snapshot, and if the DB instance is encrypted, the specifiedKmsKeyId
property is used. If you specifyDBSecurityGroups
, AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see Using Amazon RDS with Amazon VPC in the Amazon RDS User Guide. Amazon Aurora Not applicable. The KMS key identifier is managed by the DB cluster. - license
Model String - License model information for this DB instance. Valid Values: + Aurora MySQL -
general-public-license
+ Aurora PostgreSQL -postgresql-license
+ RDS for Db2 -bring-your-own-license
. For more information about RDS for Db2 licensing, see in the Amazon RDS User Guide. + 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
orlicense-included
+ RDS for PostgreSQL -postgresql-license
If you've specifiedDBSecurityGroups
and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability. - manage
Master BooleanUser Password - Specifies whether to manage the master user password with AWS Secrets Manager. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide. Constraints: + Can't manage the master user password with AWS Secrets Manager if
MasterUserPassword
is specified. - master
User StringPassword - The password for the master user. The password can include any printable ASCII character except '/', ''', or '@'. Amazon Aurora Not applicable. The password for the master user is managed by the DB cluster. RDS for Db2 Must contain from 8 to 255 characters. RDS for MariaDB Constraints: Must contain from 8 to 41 characters. RDS for Microsoft SQL Server Constraints: Must contain from 8 to 128 characters. RDS for MySQL Constraints: Must contain from 8 to 41 characters. RDS for Oracle Constraints: Must contain from 8 to 30 characters. RDS for PostgreSQL Constraints: Must contain from 8 to 128 characters.
- master
User MasterSecret User Secret Response - The secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide. The
MasterUserSecret
return value specifies the secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide and Password management with Secrets Manager in the Amazon Aurora User Guide. - master
Username String - The master user name for the DB instance. If you specify the
SourceDBInstanceIdentifier
orDBSnapshotIdentifier
property, don't specify this property. The value is inherited from the source DB instance or snapshot. When migrating a self-managed Db2 database, we recommend that you use the same master username as your self-managed Db2 instance name. Amazon Aurora Not applicable. The name for the master user is managed by the DB cluster. RDS for Db2 Constraints: + Must be 1 to 16 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for MariaDB Constraints: + Must be 1 to 16 letters or numbers. + Can't be a reserved word for the chosen database engine. RDS for Microsoft SQL Server Constraints: + Must be 1 to 128 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for MySQL Constraints: + Must be 1 to 16 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for Oracle Constraints: + Must be 1 to 30 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for PostgreSQL Constraints: + Must be 1 to 63 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. - max
Allocated IntegerStorage - The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide. This setting doesn't apply to the following DB instances: + Amazon Aurora (Storage is managed by the DB cluster.) + RDS Custom
- monitoring
Interval Integer - The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0. If
MonitoringRoleArn
is specified, then you must setMonitoringInterval
to a value other than 0. This setting doesn't apply to RDS Custom. 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 Amazon CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide. IfMonitoringInterval
is set to a value other than0
, then you must supply aMonitoringRoleArn
value. This setting doesn't apply to RDS Custom DB instances. - multi
AZ Boolean - Specifies whether the database instance is a Multi-AZ DB instance deployment. You can't set the
AvailabilityZone
parameter if theMultiAZ
parameter is set to true. For more information, see Multi-AZ deployments for high availability in the Amazon RDS User Guide. Amazon Aurora Not applicable. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require theMultiAZ
option to be set. - nchar
Character StringSet Name - The name of the NCHAR character set for the Oracle DB instance. This setting doesn't apply to RDS Custom DB instances.
- network
Type String - The network type of the DB instance. Valid values: +
IPV4
+DUAL
The network type is determined by theDBSubnetGroup
specified for the DB instance. ADBSubnetGroup
can support only the IPv4 protocol or the IPv4 and IPv6 protocols (DUAL
). For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide. - option
Group StringName - Indicates that the DB instance should be associated with the specified option group. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance.
- performance
Insights StringKMSKey Id - The AWS KMS key identifier for encryption of Performance Insights data. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for
PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region. For information about enabling Performance Insights, see EnablePerformanceInsights. - performance
Insights IntegerRetention Period - The number of days to retain Performance Insights data. This setting doesn't apply to RDS Custom DB instances. Valid Values: +
7
+ month * 31, where month is a number of months from 1-23. Examples:93
(3 months * 31),341
(11 months * 31),589
(19 months * 31) +731
Default:7
days If you specify a retention period that isn't valid, such as94
, Amazon RDS returns an error. - port String
- The port number on which the database accepts connections. Amazon Aurora Not applicable. The port number is managed by the DB cluster. Db2 Default value:
50000
- preferred
Backup StringWindow - The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod
parameter. For more information, see Backup Window in the Amazon RDS User Guide. Constraints: + Must be in the formathh24:mi-hh24:mi
. + Must be in Universal Coordinated Time (UTC). + Must not conflict with the preferred maintenance window. + Must be at least 30 minutes. Amazon Aurora Not applicable. The daily time range for creating automated backups is managed by the DB cluster. - preferred
Maintenance StringWindow - The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format:
ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window in the Amazon RDS User Guide. This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately. Constraints: Minimum 30-minute window. - processor
Features List<ProcessorFeature Response> - The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
- promotion
Tier Integer - The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide. This setting doesn't apply to RDS Custom DB instances. Default:
1
Valid Values:0 - 15
- publicly
Accessible Boolean - Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address. The default behavior value depends on your VPC setup and the database subnet group. For more information, see the
PubliclyAccessible
parameter in the CreateDBInstance in the Amazon RDS API Reference. - replica
Mode String - The open mode of an Oracle read replica. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide. This setting is only supported in RDS for Oracle. Default:
open-read-only
Valid Values:open-read-only
ormounted
- restore
Time String - The date and time to restore from. Constraints: + Must be a time in Universal Coordinated Time (UTC) format. + Must be before the latest restorable time for the DB instance. + Can't be specified if the
UseLatestRestorableTime
parameter is enabled. Example:2009-09-07T23:45:00Z
- source
DBCluster StringIdentifier - The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas. Constraints: + Must be the identifier of an existing Multi-AZ DB cluster. + Can't be specified if the
SourceDBInstanceIdentifier
parameter is also specified. + The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0. + The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported. - source
DBInstance StringAutomated Backups Arn - The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example,
arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE
. This setting doesn't apply to RDS Custom. - source
DBInstance StringIdentifier - If you want to create a read replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of read replicas. For more information, see Working with Read Replicas in the Amazon RDS User Guide. For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide. The
SourceDBInstanceIdentifier
property determines whether a DB instance is a read replica. If you remove theSourceDBInstanceIdentifier
property from your template and then update your stack, AWS CloudFormation promotes the Read Replica to a standalone DB instance. + If you specify a source DB instance that uses VPC security groups, we recommend that you specify theVPCSecurityGroups
property. If you don't specify the property, the read replica inherits the value of theVPCSecurityGroups
property from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica'sVPCSecurityGroups
property to the default value because it's not defined in the stack's template. This change might cause unexpected issues. + Read replicas don't support deletion policies. AWS CloudFormation ignores any deletion policy that's associated with a read replica. + If you specifySourceDBInstanceIdentifier
, don't specify theDBSnapshotIdentifier
property. You can't create a read replica from a snapshot. + Don't set theBackupRetentionPeriod
,DBName
,MasterUsername
,MasterUserPassword
, andPreferredBackupWindow
properties. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas. + If the source DB instance is in a different region than the read replica, specify the source region inSourceRegion
, and specify an ARN for a valid DB instance inSourceDBInstanceIdentifier
. For more information, see Constructing a Amazon RDS Amazon Resource Name (ARN) in the Amazon RDS User Guide. + For DB instances in Amazon Aurora clusters, don't specify this property. Amazon RDS automatically assigns writer and reader DB instances. - source
Dbi StringResource Id - The resource ID of the source DB instance from which to restore.
- source
Region String - The ID of the region that contains the source DB instance for the read replica.
- storage
Encrypted Boolean - A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. If you specify the
KmsKeyId
property, then you must enable encryption. If you specify theSourceDBInstanceIdentifier
property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specifiedKmsKeyId
property is used. If you specify theDBSnapshotIdentifier
and the specified snapshot is encrypted, don't specify this property. The value is inherited from the snapshot, and the specifiedKmsKeyId
property is used. If you specify theDBSnapshotIdentifier
and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB instance is encrypted. Specify theKmsKeyId
property for the KMS key to use for encryption. If you don't want the restored DB instance to be encrypted, then don't set this property or set it tofalse
. Amazon Aurora Not applicable. The encryption for DB instances is managed by the DB cluster. - storage
Throughput Integer - Specifies the storage throughput value for the DB instance. This setting applies only to the
gp3
storage type. This setting doesn't apply to RDS Custom or Amazon Aurora. - storage
Type String - The storage type to associate with the DB instance. If you specify
io1
,io2
, orgp3
, you must also include a value for theIops
parameter. This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster. Valid Values:gp2 | gp3 | io1 | io2 | standard
Default:io1
, if theIops
parameter is specified. Otherwise,gp2
. - List<Tag
Response> - An optional array of key-value pairs to apply to this DB instance.
- tde
Credential StringArn - Property tdeCredentialArn
- tde
Credential StringPassword - Property tdeCredentialPassword
- timezone String
- The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.
- use
Default BooleanProcessor Features - Specifies whether the DB instance class of the DB instance uses its default processor features. This setting doesn't apply to RDS Custom DB instances.
- use
Latest BooleanRestorable Time - Specifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time. Constraints: + Can't be specified if the
RestoreTime
parameter is provided. - vpc
Security List<String>Groups - A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to AWS::EC2::SecurityGroup resources created in the template. If you plan to update the resource, don't specify VPC security groups in a shared VPC. If you set
VPCSecurityGroups
, you must not set DBSecurityGroups, and vice versa. You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind: + You can't revert to using an RDS security group after you establish a VPC security group membership. + When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group. + To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the DBSecurityGroups property. To avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template. Amazon Aurora Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
- allocated
Storage string - The amount of storage in gibibytes (GiB) to be initially allocated for the database instance. If any value is set in the
Iops
parameter,AllocatedStorage
must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase theIops
value (in 1,000 IOPS increments), then you must also increase theAllocatedStorage
value (in 100-GiB increments). Amazon Aurora Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume. Db2 Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000. + Provisioned IOPS storage (io1): Must be an integer from 100 to 64000. MySQL Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. MariaDB Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. PostgreSQL Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. Oracle Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 10 to 3072. SQL Server Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): + Enterprise and Standard editions: Must be an integer from 20 to 16384. + Web and Express editions: Must be an integer from 20 to 16384. + Provisioned IOPS storage (io1): + Enterprise and Standard editions: Must be an integer from 20 to 16384. + Web and Express editions: Must be an integer from 20 to 16384. + Magnetic storage (standard): + Enterprise and Standard editions: Must be an integer from 20 to 1024. + Web and Express editions: Must be an integer from 20 to 1024. - allow
Major booleanVersion Upgrade - A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Constraints: Major version upgrades must be allowed when specifying a value for the
EngineVersion
parameter that is a different major version than the DB instance's current version. - associated
Roles DBInstanceRole Response[] - The IAMlong (IAM) roles associated with the DB instance. Amazon Aurora Not applicable. The associated roles are managed by the DB cluster.
- auto
Minor booleanVersion Upgrade - A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.
- automatic
Backup stringReplication Kms Key Id - Property automaticBackupReplicationKmsKeyId
- automatic
Backup stringReplication Region - The destination region for the backup replication of the DB instance. For more info, see Replicating automated backups to another Region in the Amazon RDS User Guide.
- availability
Zone string - The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see Regions and Availability Zones. For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one. Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region. Constraints: + The
AvailabilityZone
parameter can't be specified if the DB instance is a Multi-AZ deployment. + The specified Availability Zone must be in the same AWS-Region as the current endpoint. Example:us-east-1d
- backup
Retention numberPeriod - The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Amazon Aurora Not applicable. The retention period for automated backups is managed by the DB cluster. Default: 1 Constraints: + Must be a value from 0 to 35 + Can't be set to 0 if the DB instance is a source to read replicas
- ca
Certificate stringIdentifier - The identifier of the CA certificate for this DB instance. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- certificate
Details CertificateDetails Response - The details of the DB instance's server certificate. Returns the details of the DB instance’s server certificate. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- certificate
Rotation booleanRestart - Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate. By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. Set this parameter only if you are not using SSL/TLS to connect to the DB instance. If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate: + For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide. + For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide. This setting doesn't apply to RDS Custom DB instances.
- character
Set stringName - For supported engines, indicates that the DB instance should be associated with the specified character set. Amazon Aurora Not applicable. The character set is managed by the DB cluster. For more information, see AWS::RDS::DBCluster.
- boolean
- Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
- custom
IAMInstance stringProfile - The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. This setting is required for RDS Custom. Constraints: + The profile must exist in your account. + The profile must have an IAM role that Amazon EC2 has permissions to assume. + The instance profile name and the associated IAM role name must start with the prefix
AWSRDSCustom
. For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide. - db
Cluster stringIdentifier - The identifier of the DB cluster that the instance will belong to.
- db
Cluster stringSnapshot Identifier - The identifier for the Multi-AZ DB cluster snapshot to restore from. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide. Constraints: + Must match the identifier of an existing Multi-AZ DB cluster snapshot. + Can't be specified when
DBSnapshotIdentifier
is specified. + Must be specified whenDBSnapshotIdentifier
isn't specified. + If you are restoring from a shared manual Multi-AZ DB cluster snapshot, theDBClusterSnapshotIdentifier
must be the ARN of the shared snapshot. + Can't be the identifier of an Aurora DB cluster snapshot. - db
Instance stringArn - Property dbInstanceArn
- db
Instance stringClass - The compute and memory capacity of the DB instance, for example
db.m5.large
. Not all DB instance classes are available in all AWS-Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB instance classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide. - db
Instance stringIdentifier - A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see Name Type. For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
- db
Name string - The meaning of this parameter differs according to the database engine you use. If you specify the
DBSnapshotIdentifier
property, this property only applies to RDS for Oracle. Amazon Aurora Not applicable. The database name is managed by the DB cluster. Db2 The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. Constraints: + Must contain 1 to 64 letters or numbers. + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + Can't be a word reserved by the specified database engine. MySQL 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. Constraints: + Must contain 1 to 64 letters or numbers. + Can't be a word reserved by the specified database engine MariaDB 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. Constraints: + Must contain 1 to 64 letters or numbers. + Can't be a word reserved by the specified database engine PostgreSQL The name of the database to create when the DB instance is created. If this parameter is not specified, the defaultpostgres
database is created in the DB instance. Constraints: + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + Must contain 1 to 63 characters. + Can't be a word reserved by the specified database engine Oracle The Oracle System ID (SID) of the created DB instance. If you specifynull
, the default valueORCL
is used. You can't specify the string NULL, or any other reserved word, forDBName
. Default:ORCL
Constraints: + Can't be longer than 8 characters SQL Server Not applicable. Must be null. - db
Parameter stringGroup Name - The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template. To list all of the available DB parameter group names, use the following command:
aws rds describe-db-parameter-groups --query 'DBParameterGroups[].DBParameterGroupName' --output text
If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot. If you don't specify a value forDBParameterGroupName
property, the default DB parameter group for the specified engine and engine version is used. - db
Security string[]Groups - A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template. If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups. If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations: +
AllocatedStorage
+AutoMinorVersionUpgrade
+AvailabilityZone
+BackupRetentionPeriod
+CharacterSetName
+DBInstanceClass
+DBName
+DBParameterGroupName
+DBSecurityGroups
+DBSubnetGroupName
+Engine
+EngineVersion
+Iops
+LicenseModel
+MasterUsername
+MasterUserPassword
+MultiAZ
+OptionGroupName
+PreferredBackupWindow
+PreferredMaintenanceWindow
All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such asStorageType
,StorageEncrypted
, orKmsKeyId
. If you're already using theDBSecurityGroups
property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance. - db
Snapshot stringIdentifier - The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot. By specifying this property, you can create a DB instance from the specified DB snapshot. If the
DBSnapshotIdentifier
property is an empty string or theAWS::RDS::DBInstance
declaration has noDBSnapshotIdentifier
property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack. Some DB instance properties aren't valid when you restore from a snapshot, such as theMasterUsername
andMasterUserPassword
properties. For information about the properties that you can specify, see theRestoreDBInstanceFromDBSnapshot
action in the Amazon RDS API Reference. After you restore a DB instance with aDBSnapshotIdentifier
property, you must specify the sameDBSnapshotIdentifier
property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify theDBSnapshotIdentifier
property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specifiedDBSnapshotIdentifier
property, and the original DB instance is deleted. If you specify theDBSnapshotIdentifier
property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties: +CharacterSetName
+DBClusterIdentifier
+DBName
+DeleteAutomatedBackups
+EnablePerformanceInsights
+KmsKeyId
+MasterUsername
+MasterUserPassword
+PerformanceInsightsKMSKeyId
+PerformanceInsightsRetentionPeriod
+PromotionTier
+SourceDBInstanceIdentifier
+SourceRegion
+StorageEncrypted
(for an encrypted snapshot) +Timezone
Amazon Aurora Not applicable. Snapshot restore is managed by the DB cluster. - db
Subnet stringGroup Name - A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC. If there's no DB subnet group, then the DB instance isn't a VPC DB instance. For more information about using Amazon RDS in a VPC, see Using Amazon RDS with Amazon Virtual Private Cloud (VPC) in the Amazon RDS User Guide. Amazon Aurora Not applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
- db
System stringId - The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term 'Oracle database instance' refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to
RDSCDB
. The Oracle SID is also the name of your CDB. - dbi
Resource stringId - Property dbiResourceId
- dedicated
Log booleanVolume - Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
- delete
Automated booleanBackups - A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted. Amazon Aurora Not applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted.
- deletion
Protection boolean - A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance. Amazon Aurora Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see
CreateDBCluster
. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster. - domain string
- The Active Directory directory ID to create the DB instance in. Currently, only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see Kerberos Authentication in the Amazon RDS User Guide.
- domain
Auth stringSecret Arn - The ARN for the Secrets Manager secret with the credentials for the user joining the domain. Example:
arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
- domain
Dns string[]Ips - The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers. Constraints: + 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. Example:
123.124.125.126,234.235.236.237
- domain
Fqdn string - The fully qualified domain name (FQDN) of an Active Directory domain. Constraints: + Can't be longer than 64 characters. Example:
mymanagedADtest.mymanagedAD.mydomain
- domain
IAMRole stringName - The name of the IAM role to use when making API calls to the Directory Service. This setting doesn't apply to the following DB instances: + Amazon Aurora (The domain is managed by the DB cluster.) + RDS Custom
- domain
Ou string - The Active Directory organizational unit for your DB instance to join. Constraints: + Must be in the distinguished name format. + Can't be longer than 64 characters. Example:
OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
- enable
Cloudwatch string[]Logs Exports - The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service User Guide. Amazon Aurora Not applicable. CloudWatch Logs exports are managed by the DB cluster. Db2 Valid values:
diag.log
,notify.log
MariaDB Valid values:audit
,error
,general
,slowquery
Microsoft SQL Server Valid values:agent
,error
MySQL Valid values:audit
,error
,general
,slowquery
Oracle Valid values:alert
,audit
,listener
,trace
,oemagent
PostgreSQL Valid values:postgresql
,upgrade
- enable
IAMDatabase booleanAuthentication - A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see IAM Database Authentication for MariaDB, MySQL, and PostgreSQL in the Amazon RDS User Guide. Amazon Aurora Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
- enable
Performance booleanInsights - Specifies whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom DB instances.
- endpoint
Rds
Db Instance Endpoint Response - The connection endpoint for the DB instance. The endpoint might not be shown for instances with the status of
creating
. This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions: +CreateDBInstance
+DescribeDBInstances
+DeleteDBInstance
For the data structure that represents Amazon Aurora DB cluster endpoints, seeDBClusterEndpoint
. - engine string
- The name of the database engine to use for this DB instance. Not every database engine is available in every AWS Region. This property is required when creating a DB instance. You can change the architecture of an Oracle database from the non-container database (CDB) architecture to the CDB architecture by updating the
Engine
value in your templates fromoracle-ee
ororacle-ee-cdb
tooracle-se2-cdb
. Converting to the CDB architecture requires an interruption. Valid Values: +aurora-mysql
(for Aurora MySQL DB instances) +aurora-postgresql
(for Aurora PostgreSQL DB instances) +custom-oracle-ee
(for RDS Custom for Oracle DB instances) +custom-oracle-ee-cdb
(for RDS Custom for Oracle DB instances) +custom-sqlserver-ee
(for RDS Custom for SQL Server DB instances) +custom-sqlserver-se
(for RDS Custom for SQL Server DB instances) +custom-sqlserver-web
(for RDS Custom for SQL Server DB instances) +db2-ae
+db2-se
+mariadb
+mysql
+oracle-ee
+oracle-ee-cdb
+oracle-se2
+oracle-se2-cdb
+postgres
+sqlserver-ee
+sqlserver-se
+sqlserver-ex
+sqlserver-web
- engine
Version string - The version number of the database engine to use. For a list of valid engine versions, use the
DescribeDBEngineVersions
action. The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region. Amazon Aurora Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. Db2 See Amazon RDS for Db2 in the Amazon RDS User Guide. MariaDB See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide. Microsoft SQL Server See Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide. MySQL See MySQL on Amazon RDS Versions in the Amazon RDS User Guide. Oracle See Oracle Database Engine Release Notes in the Amazon RDS User Guide. PostgreSQL See Supported PostgreSQL Database Versions in the Amazon RDS User Guide. - iops number
- The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide. If you specify
io1
for theStorageType
property, then you must also specify theIops
property. Constraints: + For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance. + For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance. - kms
Key stringId - The ARN of the AWS KMS key that's used to encrypt the DB instance, such as
arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef
. If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default KMS key. If you specify this property, you must set the StorageEncrypted property to true. If you specify theSourceDBInstanceIdentifier
property, the value is inherited from the source DB instance if the read replica is created in the same region. If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region. If you specify theSnapshotIdentifier
property, theStorageEncrypted
property value is inherited from the snapshot, and if the DB instance is encrypted, the specifiedKmsKeyId
property is used. If you specifyDBSecurityGroups
, AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see Using Amazon RDS with Amazon VPC in the Amazon RDS User Guide. Amazon Aurora Not applicable. The KMS key identifier is managed by the DB cluster. - license
Model string - License model information for this DB instance. Valid Values: + Aurora MySQL -
general-public-license
+ Aurora PostgreSQL -postgresql-license
+ RDS for Db2 -bring-your-own-license
. For more information about RDS for Db2 licensing, see in the Amazon RDS User Guide. + 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
orlicense-included
+ RDS for PostgreSQL -postgresql-license
If you've specifiedDBSecurityGroups
and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability. - manage
Master booleanUser Password - Specifies whether to manage the master user password with AWS Secrets Manager. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide. Constraints: + Can't manage the master user password with AWS Secrets Manager if
MasterUserPassword
is specified. - master
User stringPassword - The password for the master user. The password can include any printable ASCII character except '/', ''', or '@'. Amazon Aurora Not applicable. The password for the master user is managed by the DB cluster. RDS for Db2 Must contain from 8 to 255 characters. RDS for MariaDB Constraints: Must contain from 8 to 41 characters. RDS for Microsoft SQL Server Constraints: Must contain from 8 to 128 characters. RDS for MySQL Constraints: Must contain from 8 to 41 characters. RDS for Oracle Constraints: Must contain from 8 to 30 characters. RDS for PostgreSQL Constraints: Must contain from 8 to 128 characters.
- master
User MasterSecret User Secret Response - The secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide. The
MasterUserSecret
return value specifies the secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide and Password management with Secrets Manager in the Amazon Aurora User Guide. - master
Username string - The master user name for the DB instance. If you specify the
SourceDBInstanceIdentifier
orDBSnapshotIdentifier
property, don't specify this property. The value is inherited from the source DB instance or snapshot. When migrating a self-managed Db2 database, we recommend that you use the same master username as your self-managed Db2 instance name. Amazon Aurora Not applicable. The name for the master user is managed by the DB cluster. RDS for Db2 Constraints: + Must be 1 to 16 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for MariaDB Constraints: + Must be 1 to 16 letters or numbers. + Can't be a reserved word for the chosen database engine. RDS for Microsoft SQL Server Constraints: + Must be 1 to 128 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for MySQL Constraints: + Must be 1 to 16 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for Oracle Constraints: + Must be 1 to 30 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for PostgreSQL Constraints: + Must be 1 to 63 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. - max
Allocated numberStorage - The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide. This setting doesn't apply to the following DB instances: + Amazon Aurora (Storage is managed by the DB cluster.) + RDS Custom
- monitoring
Interval number - The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0. If
MonitoringRoleArn
is specified, then you must setMonitoringInterval
to a value other than 0. This setting doesn't apply to RDS Custom. 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 Amazon CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide. IfMonitoringInterval
is set to a value other than0
, then you must supply aMonitoringRoleArn
value. This setting doesn't apply to RDS Custom DB instances. - multi
AZ boolean - Specifies whether the database instance is a Multi-AZ DB instance deployment. You can't set the
AvailabilityZone
parameter if theMultiAZ
parameter is set to true. For more information, see Multi-AZ deployments for high availability in the Amazon RDS User Guide. Amazon Aurora Not applicable. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require theMultiAZ
option to be set. - nchar
Character stringSet Name - The name of the NCHAR character set for the Oracle DB instance. This setting doesn't apply to RDS Custom DB instances.
- network
Type string - The network type of the DB instance. Valid values: +
IPV4
+DUAL
The network type is determined by theDBSubnetGroup
specified for the DB instance. ADBSubnetGroup
can support only the IPv4 protocol or the IPv4 and IPv6 protocols (DUAL
). For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide. - option
Group stringName - Indicates that the DB instance should be associated with the specified option group. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance.
- performance
Insights stringKMSKey Id - The AWS KMS key identifier for encryption of Performance Insights data. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for
PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region. For information about enabling Performance Insights, see EnablePerformanceInsights. - performance
Insights numberRetention Period - The number of days to retain Performance Insights data. This setting doesn't apply to RDS Custom DB instances. Valid Values: +
7
+ month * 31, where month is a number of months from 1-23. Examples:93
(3 months * 31),341
(11 months * 31),589
(19 months * 31) +731
Default:7
days If you specify a retention period that isn't valid, such as94
, Amazon RDS returns an error. - port string
- The port number on which the database accepts connections. Amazon Aurora Not applicable. The port number is managed by the DB cluster. Db2 Default value:
50000
- preferred
Backup stringWindow - The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod
parameter. For more information, see Backup Window in the Amazon RDS User Guide. Constraints: + Must be in the formathh24:mi-hh24:mi
. + Must be in Universal Coordinated Time (UTC). + Must not conflict with the preferred maintenance window. + Must be at least 30 minutes. Amazon Aurora Not applicable. The daily time range for creating automated backups is managed by the DB cluster. - preferred
Maintenance stringWindow - The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format:
ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window in the Amazon RDS User Guide. This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately. Constraints: Minimum 30-minute window. - processor
Features ProcessorFeature Response[] - The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
- promotion
Tier number - The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide. This setting doesn't apply to RDS Custom DB instances. Default:
1
Valid Values:0 - 15
- publicly
Accessible boolean - Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address. The default behavior value depends on your VPC setup and the database subnet group. For more information, see the
PubliclyAccessible
parameter in the CreateDBInstance in the Amazon RDS API Reference. - replica
Mode string - The open mode of an Oracle read replica. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide. This setting is only supported in RDS for Oracle. Default:
open-read-only
Valid Values:open-read-only
ormounted
- restore
Time string - The date and time to restore from. Constraints: + Must be a time in Universal Coordinated Time (UTC) format. + Must be before the latest restorable time for the DB instance. + Can't be specified if the
UseLatestRestorableTime
parameter is enabled. Example:2009-09-07T23:45:00Z
- source
DBCluster stringIdentifier - The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas. Constraints: + Must be the identifier of an existing Multi-AZ DB cluster. + Can't be specified if the
SourceDBInstanceIdentifier
parameter is also specified. + The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0. + The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported. - source
DBInstance stringAutomated Backups Arn - The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example,
arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE
. This setting doesn't apply to RDS Custom. - source
DBInstance stringIdentifier - If you want to create a read replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of read replicas. For more information, see Working with Read Replicas in the Amazon RDS User Guide. For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide. The
SourceDBInstanceIdentifier
property determines whether a DB instance is a read replica. If you remove theSourceDBInstanceIdentifier
property from your template and then update your stack, AWS CloudFormation promotes the Read Replica to a standalone DB instance. + If you specify a source DB instance that uses VPC security groups, we recommend that you specify theVPCSecurityGroups
property. If you don't specify the property, the read replica inherits the value of theVPCSecurityGroups
property from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica'sVPCSecurityGroups
property to the default value because it's not defined in the stack's template. This change might cause unexpected issues. + Read replicas don't support deletion policies. AWS CloudFormation ignores any deletion policy that's associated with a read replica. + If you specifySourceDBInstanceIdentifier
, don't specify theDBSnapshotIdentifier
property. You can't create a read replica from a snapshot. + Don't set theBackupRetentionPeriod
,DBName
,MasterUsername
,MasterUserPassword
, andPreferredBackupWindow
properties. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas. + If the source DB instance is in a different region than the read replica, specify the source region inSourceRegion
, and specify an ARN for a valid DB instance inSourceDBInstanceIdentifier
. For more information, see Constructing a Amazon RDS Amazon Resource Name (ARN) in the Amazon RDS User Guide. + For DB instances in Amazon Aurora clusters, don't specify this property. Amazon RDS automatically assigns writer and reader DB instances. - source
Dbi stringResource Id - The resource ID of the source DB instance from which to restore.
- source
Region string - The ID of the region that contains the source DB instance for the read replica.
- storage
Encrypted boolean - A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. If you specify the
KmsKeyId
property, then you must enable encryption. If you specify theSourceDBInstanceIdentifier
property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specifiedKmsKeyId
property is used. If you specify theDBSnapshotIdentifier
and the specified snapshot is encrypted, don't specify this property. The value is inherited from the snapshot, and the specifiedKmsKeyId
property is used. If you specify theDBSnapshotIdentifier
and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB instance is encrypted. Specify theKmsKeyId
property for the KMS key to use for encryption. If you don't want the restored DB instance to be encrypted, then don't set this property or set it tofalse
. Amazon Aurora Not applicable. The encryption for DB instances is managed by the DB cluster. - storage
Throughput number - Specifies the storage throughput value for the DB instance. This setting applies only to the
gp3
storage type. This setting doesn't apply to RDS Custom or Amazon Aurora. - storage
Type string - The storage type to associate with the DB instance. If you specify
io1
,io2
, orgp3
, you must also include a value for theIops
parameter. This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster. Valid Values:gp2 | gp3 | io1 | io2 | standard
Default:io1
, if theIops
parameter is specified. Otherwise,gp2
. - Tag
Response[] - An optional array of key-value pairs to apply to this DB instance.
- tde
Credential stringArn - Property tdeCredentialArn
- tde
Credential stringPassword - Property tdeCredentialPassword
- timezone string
- The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.
- use
Default booleanProcessor Features - Specifies whether the DB instance class of the DB instance uses its default processor features. This setting doesn't apply to RDS Custom DB instances.
- use
Latest booleanRestorable Time - Specifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time. Constraints: + Can't be specified if the
RestoreTime
parameter is provided. - vpc
Security string[]Groups - A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to AWS::EC2::SecurityGroup resources created in the template. If you plan to update the resource, don't specify VPC security groups in a shared VPC. If you set
VPCSecurityGroups
, you must not set DBSecurityGroups, and vice versa. You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind: + You can't revert to using an RDS security group after you establish a VPC security group membership. + When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group. + To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the DBSecurityGroups property. To avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template. Amazon Aurora Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
- allocated_
storage str - The amount of storage in gibibytes (GiB) to be initially allocated for the database instance. If any value is set in the
Iops
parameter,AllocatedStorage
must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase theIops
value (in 1,000 IOPS increments), then you must also increase theAllocatedStorage
value (in 100-GiB increments). Amazon Aurora Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume. Db2 Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000. + Provisioned IOPS storage (io1): Must be an integer from 100 to 64000. MySQL Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. MariaDB Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. PostgreSQL Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. Oracle Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 10 to 3072. SQL Server Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): + Enterprise and Standard editions: Must be an integer from 20 to 16384. + Web and Express editions: Must be an integer from 20 to 16384. + Provisioned IOPS storage (io1): + Enterprise and Standard editions: Must be an integer from 20 to 16384. + Web and Express editions: Must be an integer from 20 to 16384. + Magnetic storage (standard): + Enterprise and Standard editions: Must be an integer from 20 to 1024. + Web and Express editions: Must be an integer from 20 to 1024. - allow_
major_ boolversion_ upgrade - A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Constraints: Major version upgrades must be allowed when specifying a value for the
EngineVersion
parameter that is a different major version than the DB instance's current version. - associated_
roles Sequence[DBInstanceRole Response] - The IAMlong (IAM) roles associated with the DB instance. Amazon Aurora Not applicable. The associated roles are managed by the DB cluster.
- auto_
minor_ boolversion_ upgrade - A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.
- automatic_
backup_ strreplication_ kms_ key_ id - Property automaticBackupReplicationKmsKeyId
- automatic_
backup_ strreplication_ region - The destination region for the backup replication of the DB instance. For more info, see Replicating automated backups to another Region in the Amazon RDS User Guide.
- availability_
zone str - The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see Regions and Availability Zones. For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one. Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region. Constraints: + The
AvailabilityZone
parameter can't be specified if the DB instance is a Multi-AZ deployment. + The specified Availability Zone must be in the same AWS-Region as the current endpoint. Example:us-east-1d
- backup_
retention_ intperiod - The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Amazon Aurora Not applicable. The retention period for automated backups is managed by the DB cluster. Default: 1 Constraints: + Must be a value from 0 to 35 + Can't be set to 0 if the DB instance is a source to read replicas
- ca_
certificate_ stridentifier - The identifier of the CA certificate for this DB instance. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- certificate_
details CertificateDetails Response - The details of the DB instance's server certificate. Returns the details of the DB instance’s server certificate. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- certificate_
rotation_ boolrestart - Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate. By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. Set this parameter only if you are not using SSL/TLS to connect to the DB instance. If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate: + For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide. + For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide. This setting doesn't apply to RDS Custom DB instances.
- character_
set_ strname - For supported engines, indicates that the DB instance should be associated with the specified character set. Amazon Aurora Not applicable. The character set is managed by the DB cluster. For more information, see AWS::RDS::DBCluster.
- bool
- Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
- custom_
iam_ strinstance_ profile - The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. This setting is required for RDS Custom. Constraints: + The profile must exist in your account. + The profile must have an IAM role that Amazon EC2 has permissions to assume. + The instance profile name and the associated IAM role name must start with the prefix
AWSRDSCustom
. For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide. - db_
cluster_ stridentifier - The identifier of the DB cluster that the instance will belong to.
- db_
cluster_ strsnapshot_ identifier - The identifier for the Multi-AZ DB cluster snapshot to restore from. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide. Constraints: + Must match the identifier of an existing Multi-AZ DB cluster snapshot. + Can't be specified when
DBSnapshotIdentifier
is specified. + Must be specified whenDBSnapshotIdentifier
isn't specified. + If you are restoring from a shared manual Multi-AZ DB cluster snapshot, theDBClusterSnapshotIdentifier
must be the ARN of the shared snapshot. + Can't be the identifier of an Aurora DB cluster snapshot. - db_
instance_ strarn - Property dbInstanceArn
- db_
instance_ strclass - The compute and memory capacity of the DB instance, for example
db.m5.large
. Not all DB instance classes are available in all AWS-Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB instance classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide. - db_
instance_ stridentifier - A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see Name Type. For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
- db_
name str - The meaning of this parameter differs according to the database engine you use. If you specify the
DBSnapshotIdentifier
property, this property only applies to RDS for Oracle. Amazon Aurora Not applicable. The database name is managed by the DB cluster. Db2 The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. Constraints: + Must contain 1 to 64 letters or numbers. + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + Can't be a word reserved by the specified database engine. MySQL 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. Constraints: + Must contain 1 to 64 letters or numbers. + Can't be a word reserved by the specified database engine MariaDB 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. Constraints: + Must contain 1 to 64 letters or numbers. + Can't be a word reserved by the specified database engine PostgreSQL The name of the database to create when the DB instance is created. If this parameter is not specified, the defaultpostgres
database is created in the DB instance. Constraints: + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + Must contain 1 to 63 characters. + Can't be a word reserved by the specified database engine Oracle The Oracle System ID (SID) of the created DB instance. If you specifynull
, the default valueORCL
is used. You can't specify the string NULL, or any other reserved word, forDBName
. Default:ORCL
Constraints: + Can't be longer than 8 characters SQL Server Not applicable. Must be null. - db_
parameter_ strgroup_ name - The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template. To list all of the available DB parameter group names, use the following command:
aws rds describe-db-parameter-groups --query 'DBParameterGroups[].DBParameterGroupName' --output text
If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot. If you don't specify a value forDBParameterGroupName
property, the default DB parameter group for the specified engine and engine version is used. - db_
security_ Sequence[str]groups - A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template. If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups. If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations: +
AllocatedStorage
+AutoMinorVersionUpgrade
+AvailabilityZone
+BackupRetentionPeriod
+CharacterSetName
+DBInstanceClass
+DBName
+DBParameterGroupName
+DBSecurityGroups
+DBSubnetGroupName
+Engine
+EngineVersion
+Iops
+LicenseModel
+MasterUsername
+MasterUserPassword
+MultiAZ
+OptionGroupName
+PreferredBackupWindow
+PreferredMaintenanceWindow
All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such asStorageType
,StorageEncrypted
, orKmsKeyId
. If you're already using theDBSecurityGroups
property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance. - db_
snapshot_ stridentifier - The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot. By specifying this property, you can create a DB instance from the specified DB snapshot. If the
DBSnapshotIdentifier
property is an empty string or theAWS::RDS::DBInstance
declaration has noDBSnapshotIdentifier
property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack. Some DB instance properties aren't valid when you restore from a snapshot, such as theMasterUsername
andMasterUserPassword
properties. For information about the properties that you can specify, see theRestoreDBInstanceFromDBSnapshot
action in the Amazon RDS API Reference. After you restore a DB instance with aDBSnapshotIdentifier
property, you must specify the sameDBSnapshotIdentifier
property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify theDBSnapshotIdentifier
property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specifiedDBSnapshotIdentifier
property, and the original DB instance is deleted. If you specify theDBSnapshotIdentifier
property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties: +CharacterSetName
+DBClusterIdentifier
+DBName
+DeleteAutomatedBackups
+EnablePerformanceInsights
+KmsKeyId
+MasterUsername
+MasterUserPassword
+PerformanceInsightsKMSKeyId
+PerformanceInsightsRetentionPeriod
+PromotionTier
+SourceDBInstanceIdentifier
+SourceRegion
+StorageEncrypted
(for an encrypted snapshot) +Timezone
Amazon Aurora Not applicable. Snapshot restore is managed by the DB cluster. - db_
subnet_ strgroup_ name - A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC. If there's no DB subnet group, then the DB instance isn't a VPC DB instance. For more information about using Amazon RDS in a VPC, see Using Amazon RDS with Amazon Virtual Private Cloud (VPC) in the Amazon RDS User Guide. Amazon Aurora Not applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
- db_
system_ strid - The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term 'Oracle database instance' refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to
RDSCDB
. The Oracle SID is also the name of your CDB. - dbi_
resource_ strid - Property dbiResourceId
- dedicated_
log_ boolvolume - Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
- delete_
automated_ boolbackups - A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted. Amazon Aurora Not applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted.
- deletion_
protection bool - A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance. Amazon Aurora Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see
CreateDBCluster
. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster. - domain str
- The Active Directory directory ID to create the DB instance in. Currently, only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see Kerberos Authentication in the Amazon RDS User Guide.
- domain_
auth_ strsecret_ arn - The ARN for the Secrets Manager secret with the credentials for the user joining the domain. Example:
arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
- domain_
dns_ Sequence[str]ips - The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers. Constraints: + 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. Example:
123.124.125.126,234.235.236.237
- domain_
fqdn str - The fully qualified domain name (FQDN) of an Active Directory domain. Constraints: + Can't be longer than 64 characters. Example:
mymanagedADtest.mymanagedAD.mydomain
- domain_
iam_ strrole_ name - The name of the IAM role to use when making API calls to the Directory Service. This setting doesn't apply to the following DB instances: + Amazon Aurora (The domain is managed by the DB cluster.) + RDS Custom
- domain_
ou str - The Active Directory organizational unit for your DB instance to join. Constraints: + Must be in the distinguished name format. + Can't be longer than 64 characters. Example:
OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
- enable_
cloudwatch_ Sequence[str]logs_ exports - The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service User Guide. Amazon Aurora Not applicable. CloudWatch Logs exports are managed by the DB cluster. Db2 Valid values:
diag.log
,notify.log
MariaDB Valid values:audit
,error
,general
,slowquery
Microsoft SQL Server Valid values:agent
,error
MySQL Valid values:audit
,error
,general
,slowquery
Oracle Valid values:alert
,audit
,listener
,trace
,oemagent
PostgreSQL Valid values:postgresql
,upgrade
- enable_
iam_ booldatabase_ authentication - A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see IAM Database Authentication for MariaDB, MySQL, and PostgreSQL in the Amazon RDS User Guide. Amazon Aurora Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
- enable_
performance_ boolinsights - Specifies whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom DB instances.
- endpoint
Rds
Db Instance Endpoint Response - The connection endpoint for the DB instance. The endpoint might not be shown for instances with the status of
creating
. This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions: +CreateDBInstance
+DescribeDBInstances
+DeleteDBInstance
For the data structure that represents Amazon Aurora DB cluster endpoints, seeDBClusterEndpoint
. - engine str
- The name of the database engine to use for this DB instance. Not every database engine is available in every AWS Region. This property is required when creating a DB instance. You can change the architecture of an Oracle database from the non-container database (CDB) architecture to the CDB architecture by updating the
Engine
value in your templates fromoracle-ee
ororacle-ee-cdb
tooracle-se2-cdb
. Converting to the CDB architecture requires an interruption. Valid Values: +aurora-mysql
(for Aurora MySQL DB instances) +aurora-postgresql
(for Aurora PostgreSQL DB instances) +custom-oracle-ee
(for RDS Custom for Oracle DB instances) +custom-oracle-ee-cdb
(for RDS Custom for Oracle DB instances) +custom-sqlserver-ee
(for RDS Custom for SQL Server DB instances) +custom-sqlserver-se
(for RDS Custom for SQL Server DB instances) +custom-sqlserver-web
(for RDS Custom for SQL Server DB instances) +db2-ae
+db2-se
+mariadb
+mysql
+oracle-ee
+oracle-ee-cdb
+oracle-se2
+oracle-se2-cdb
+postgres
+sqlserver-ee
+sqlserver-se
+sqlserver-ex
+sqlserver-web
- engine_
version str - The version number of the database engine to use. For a list of valid engine versions, use the
DescribeDBEngineVersions
action. The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region. Amazon Aurora Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. Db2 See Amazon RDS for Db2 in the Amazon RDS User Guide. MariaDB See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide. Microsoft SQL Server See Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide. MySQL See MySQL on Amazon RDS Versions in the Amazon RDS User Guide. Oracle See Oracle Database Engine Release Notes in the Amazon RDS User Guide. PostgreSQL See Supported PostgreSQL Database Versions in the Amazon RDS User Guide. - iops int
- The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide. If you specify
io1
for theStorageType
property, then you must also specify theIops
property. Constraints: + For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance. + For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance. - kms_
key_ strid - The ARN of the AWS KMS key that's used to encrypt the DB instance, such as
arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef
. If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default KMS key. If you specify this property, you must set the StorageEncrypted property to true. If you specify theSourceDBInstanceIdentifier
property, the value is inherited from the source DB instance if the read replica is created in the same region. If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region. If you specify theSnapshotIdentifier
property, theStorageEncrypted
property value is inherited from the snapshot, and if the DB instance is encrypted, the specifiedKmsKeyId
property is used. If you specifyDBSecurityGroups
, AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see Using Amazon RDS with Amazon VPC in the Amazon RDS User Guide. Amazon Aurora Not applicable. The KMS key identifier is managed by the DB cluster. - license_
model str - License model information for this DB instance. Valid Values: + Aurora MySQL -
general-public-license
+ Aurora PostgreSQL -postgresql-license
+ RDS for Db2 -bring-your-own-license
. For more information about RDS for Db2 licensing, see in the Amazon RDS User Guide. + 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
orlicense-included
+ RDS for PostgreSQL -postgresql-license
If you've specifiedDBSecurityGroups
and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability. - manage_
master_ booluser_ password - Specifies whether to manage the master user password with AWS Secrets Manager. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide. Constraints: + Can't manage the master user password with AWS Secrets Manager if
MasterUserPassword
is specified. - master_
user_ strpassword - The password for the master user. The password can include any printable ASCII character except '/', ''', or '@'. Amazon Aurora Not applicable. The password for the master user is managed by the DB cluster. RDS for Db2 Must contain from 8 to 255 characters. RDS for MariaDB Constraints: Must contain from 8 to 41 characters. RDS for Microsoft SQL Server Constraints: Must contain from 8 to 128 characters. RDS for MySQL Constraints: Must contain from 8 to 41 characters. RDS for Oracle Constraints: Must contain from 8 to 30 characters. RDS for PostgreSQL Constraints: Must contain from 8 to 128 characters.
- master_
user_ Mastersecret User Secret Response - The secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide. The
MasterUserSecret
return value specifies the secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide and Password management with Secrets Manager in the Amazon Aurora User Guide. - master_
username str - The master user name for the DB instance. If you specify the
SourceDBInstanceIdentifier
orDBSnapshotIdentifier
property, don't specify this property. The value is inherited from the source DB instance or snapshot. When migrating a self-managed Db2 database, we recommend that you use the same master username as your self-managed Db2 instance name. Amazon Aurora Not applicable. The name for the master user is managed by the DB cluster. RDS for Db2 Constraints: + Must be 1 to 16 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for MariaDB Constraints: + Must be 1 to 16 letters or numbers. + Can't be a reserved word for the chosen database engine. RDS for Microsoft SQL Server Constraints: + Must be 1 to 128 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for MySQL Constraints: + Must be 1 to 16 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for Oracle Constraints: + Must be 1 to 30 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for PostgreSQL Constraints: + Must be 1 to 63 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. - max_
allocated_ intstorage - The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide. This setting doesn't apply to the following DB instances: + Amazon Aurora (Storage is managed by the DB cluster.) + RDS Custom
- monitoring_
interval int - The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0. If
MonitoringRoleArn
is specified, then you must setMonitoringInterval
to a value other than 0. This setting doesn't apply to RDS Custom. 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 Amazon CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide. IfMonitoringInterval
is set to a value other than0
, then you must supply aMonitoringRoleArn
value. This setting doesn't apply to RDS Custom DB instances. - multi_
az bool - Specifies whether the database instance is a Multi-AZ DB instance deployment. You can't set the
AvailabilityZone
parameter if theMultiAZ
parameter is set to true. For more information, see Multi-AZ deployments for high availability in the Amazon RDS User Guide. Amazon Aurora Not applicable. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require theMultiAZ
option to be set. - nchar_
character_ strset_ name - The name of the NCHAR character set for the Oracle DB instance. This setting doesn't apply to RDS Custom DB instances.
- network_
type str - The network type of the DB instance. Valid values: +
IPV4
+DUAL
The network type is determined by theDBSubnetGroup
specified for the DB instance. ADBSubnetGroup
can support only the IPv4 protocol or the IPv4 and IPv6 protocols (DUAL
). For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide. - option_
group_ strname - Indicates that the DB instance should be associated with the specified option group. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance.
- performance_
insights_ strkms_ key_ id - The AWS KMS key identifier for encryption of Performance Insights data. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for
PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region. For information about enabling Performance Insights, see EnablePerformanceInsights. - performance_
insights_ intretention_ period - The number of days to retain Performance Insights data. This setting doesn't apply to RDS Custom DB instances. Valid Values: +
7
+ month * 31, where month is a number of months from 1-23. Examples:93
(3 months * 31),341
(11 months * 31),589
(19 months * 31) +731
Default:7
days If you specify a retention period that isn't valid, such as94
, Amazon RDS returns an error. - port str
- The port number on which the database accepts connections. Amazon Aurora Not applicable. The port number is managed by the DB cluster. Db2 Default value:
50000
- preferred_
backup_ strwindow - The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod
parameter. For more information, see Backup Window in the Amazon RDS User Guide. Constraints: + Must be in the formathh24:mi-hh24:mi
. + Must be in Universal Coordinated Time (UTC). + Must not conflict with the preferred maintenance window. + Must be at least 30 minutes. Amazon Aurora Not applicable. The daily time range for creating automated backups is managed by the DB cluster. - preferred_
maintenance_ strwindow - The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format:
ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window in the Amazon RDS User Guide. This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately. Constraints: Minimum 30-minute window. - processor_
features Sequence[ProcessorFeature Response] - The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
- promotion_
tier int - The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide. This setting doesn't apply to RDS Custom DB instances. Default:
1
Valid Values:0 - 15
- publicly_
accessible bool - Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address. The default behavior value depends on your VPC setup and the database subnet group. For more information, see the
PubliclyAccessible
parameter in the CreateDBInstance in the Amazon RDS API Reference. - replica_
mode str - The open mode of an Oracle read replica. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide. This setting is only supported in RDS for Oracle. Default:
open-read-only
Valid Values:open-read-only
ormounted
- restore_
time str - The date and time to restore from. Constraints: + Must be a time in Universal Coordinated Time (UTC) format. + Must be before the latest restorable time for the DB instance. + Can't be specified if the
UseLatestRestorableTime
parameter is enabled. Example:2009-09-07T23:45:00Z
- source_
db_ strcluster_ identifier - The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas. Constraints: + Must be the identifier of an existing Multi-AZ DB cluster. + Can't be specified if the
SourceDBInstanceIdentifier
parameter is also specified. + The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0. + The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported. - source_
db_ strinstance_ automated_ backups_ arn - The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example,
arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE
. This setting doesn't apply to RDS Custom. - source_
db_ strinstance_ identifier - If you want to create a read replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of read replicas. For more information, see Working with Read Replicas in the Amazon RDS User Guide. For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide. The
SourceDBInstanceIdentifier
property determines whether a DB instance is a read replica. If you remove theSourceDBInstanceIdentifier
property from your template and then update your stack, AWS CloudFormation promotes the Read Replica to a standalone DB instance. + If you specify a source DB instance that uses VPC security groups, we recommend that you specify theVPCSecurityGroups
property. If you don't specify the property, the read replica inherits the value of theVPCSecurityGroups
property from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica'sVPCSecurityGroups
property to the default value because it's not defined in the stack's template. This change might cause unexpected issues. + Read replicas don't support deletion policies. AWS CloudFormation ignores any deletion policy that's associated with a read replica. + If you specifySourceDBInstanceIdentifier
, don't specify theDBSnapshotIdentifier
property. You can't create a read replica from a snapshot. + Don't set theBackupRetentionPeriod
,DBName
,MasterUsername
,MasterUserPassword
, andPreferredBackupWindow
properties. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas. + If the source DB instance is in a different region than the read replica, specify the source region inSourceRegion
, and specify an ARN for a valid DB instance inSourceDBInstanceIdentifier
. For more information, see Constructing a Amazon RDS Amazon Resource Name (ARN) in the Amazon RDS User Guide. + For DB instances in Amazon Aurora clusters, don't specify this property. Amazon RDS automatically assigns writer and reader DB instances. - source_
dbi_ strresource_ id - The resource ID of the source DB instance from which to restore.
- source_
region str - The ID of the region that contains the source DB instance for the read replica.
- storage_
encrypted bool - A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. If you specify the
KmsKeyId
property, then you must enable encryption. If you specify theSourceDBInstanceIdentifier
property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specifiedKmsKeyId
property is used. If you specify theDBSnapshotIdentifier
and the specified snapshot is encrypted, don't specify this property. The value is inherited from the snapshot, and the specifiedKmsKeyId
property is used. If you specify theDBSnapshotIdentifier
and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB instance is encrypted. Specify theKmsKeyId
property for the KMS key to use for encryption. If you don't want the restored DB instance to be encrypted, then don't set this property or set it tofalse
. Amazon Aurora Not applicable. The encryption for DB instances is managed by the DB cluster. - storage_
throughput int - Specifies the storage throughput value for the DB instance. This setting applies only to the
gp3
storage type. This setting doesn't apply to RDS Custom or Amazon Aurora. - storage_
type str - The storage type to associate with the DB instance. If you specify
io1
,io2
, orgp3
, you must also include a value for theIops
parameter. This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster. Valid Values:gp2 | gp3 | io1 | io2 | standard
Default:io1
, if theIops
parameter is specified. Otherwise,gp2
. - Sequence[Tag
Response] - An optional array of key-value pairs to apply to this DB instance.
- tde_
credential_ strarn - Property tdeCredentialArn
- tde_
credential_ strpassword - Property tdeCredentialPassword
- timezone str
- The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.
- use_
default_ boolprocessor_ features - Specifies whether the DB instance class of the DB instance uses its default processor features. This setting doesn't apply to RDS Custom DB instances.
- use_
latest_ boolrestorable_ time - Specifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time. Constraints: + Can't be specified if the
RestoreTime
parameter is provided. - vpc_
security_ Sequence[str]groups - A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to AWS::EC2::SecurityGroup resources created in the template. If you plan to update the resource, don't specify VPC security groups in a shared VPC. If you set
VPCSecurityGroups
, you must not set DBSecurityGroups, and vice versa. You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind: + You can't revert to using an RDS security group after you establish a VPC security group membership. + When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group. + To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the DBSecurityGroups property. To avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template. Amazon Aurora Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
- allocated
Storage String - The amount of storage in gibibytes (GiB) to be initially allocated for the database instance. If any value is set in the
Iops
parameter,AllocatedStorage
must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase theIops
value (in 1,000 IOPS increments), then you must also increase theAllocatedStorage
value (in 100-GiB increments). Amazon Aurora Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume. Db2 Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000. + Provisioned IOPS storage (io1): Must be an integer from 100 to 64000. MySQL Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. MariaDB Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. PostgreSQL Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. Oracle Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 10 to 3072. SQL Server Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): + Enterprise and Standard editions: Must be an integer from 20 to 16384. + Web and Express editions: Must be an integer from 20 to 16384. + Provisioned IOPS storage (io1): + Enterprise and Standard editions: Must be an integer from 20 to 16384. + Web and Express editions: Must be an integer from 20 to 16384. + Magnetic storage (standard): + Enterprise and Standard editions: Must be an integer from 20 to 1024. + Web and Express editions: Must be an integer from 20 to 1024. - allow
Major BooleanVersion Upgrade - A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Constraints: Major version upgrades must be allowed when specifying a value for the
EngineVersion
parameter that is a different major version than the DB instance's current version. - associated
Roles List<Property Map> - The IAMlong (IAM) roles associated with the DB instance. Amazon Aurora Not applicable. The associated roles are managed by the DB cluster.
- auto
Minor BooleanVersion Upgrade - A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.
- automatic
Backup StringReplication Kms Key Id - Property automaticBackupReplicationKmsKeyId
- automatic
Backup StringReplication Region - The destination region for the backup replication of the DB instance. For more info, see Replicating automated backups to another Region in the Amazon RDS User Guide.
- availability
Zone String - The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see Regions and Availability Zones. For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one. Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region. Constraints: + The
AvailabilityZone
parameter can't be specified if the DB instance is a Multi-AZ deployment. + The specified Availability Zone must be in the same AWS-Region as the current endpoint. Example:us-east-1d
- backup
Retention NumberPeriod - The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Amazon Aurora Not applicable. The retention period for automated backups is managed by the DB cluster. Default: 1 Constraints: + Must be a value from 0 to 35 + Can't be set to 0 if the DB instance is a source to read replicas
- ca
Certificate StringIdentifier - The identifier of the CA certificate for this DB instance. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- certificate
Details Property Map - The details of the DB instance's server certificate. Returns the details of the DB instance’s server certificate. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- certificate
Rotation BooleanRestart - Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate. By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. Set this parameter only if you are not using SSL/TLS to connect to the DB instance. If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate: + For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide. + For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide. This setting doesn't apply to RDS Custom DB instances.
- character
Set StringName - For supported engines, indicates that the DB instance should be associated with the specified character set. Amazon Aurora Not applicable. The character set is managed by the DB cluster. For more information, see AWS::RDS::DBCluster.
- Boolean
- Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
- custom
IAMInstance StringProfile - The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. This setting is required for RDS Custom. Constraints: + The profile must exist in your account. + The profile must have an IAM role that Amazon EC2 has permissions to assume. + The instance profile name and the associated IAM role name must start with the prefix
AWSRDSCustom
. For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide. - db
Cluster StringIdentifier - The identifier of the DB cluster that the instance will belong to.
- db
Cluster StringSnapshot Identifier - The identifier for the Multi-AZ DB cluster snapshot to restore from. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide. Constraints: + Must match the identifier of an existing Multi-AZ DB cluster snapshot. + Can't be specified when
DBSnapshotIdentifier
is specified. + Must be specified whenDBSnapshotIdentifier
isn't specified. + If you are restoring from a shared manual Multi-AZ DB cluster snapshot, theDBClusterSnapshotIdentifier
must be the ARN of the shared snapshot. + Can't be the identifier of an Aurora DB cluster snapshot. - db
Instance StringArn - Property dbInstanceArn
- db
Instance StringClass - The compute and memory capacity of the DB instance, for example
db.m5.large
. Not all DB instance classes are available in all AWS-Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB instance classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide. - db
Instance StringIdentifier - A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see Name Type. For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
- db
Name String - The meaning of this parameter differs according to the database engine you use. If you specify the
DBSnapshotIdentifier
property, this property only applies to RDS for Oracle. Amazon Aurora Not applicable. The database name is managed by the DB cluster. Db2 The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. Constraints: + Must contain 1 to 64 letters or numbers. + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + Can't be a word reserved by the specified database engine. MySQL 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. Constraints: + Must contain 1 to 64 letters or numbers. + Can't be a word reserved by the specified database engine MariaDB 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. Constraints: + Must contain 1 to 64 letters or numbers. + Can't be a word reserved by the specified database engine PostgreSQL The name of the database to create when the DB instance is created. If this parameter is not specified, the defaultpostgres
database is created in the DB instance. Constraints: + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + Must contain 1 to 63 characters. + Can't be a word reserved by the specified database engine Oracle The Oracle System ID (SID) of the created DB instance. If you specifynull
, the default valueORCL
is used. You can't specify the string NULL, or any other reserved word, forDBName
. Default:ORCL
Constraints: + Can't be longer than 8 characters SQL Server Not applicable. Must be null. - db
Parameter StringGroup Name - The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template. To list all of the available DB parameter group names, use the following command:
aws rds describe-db-parameter-groups --query 'DBParameterGroups[].DBParameterGroupName' --output text
If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot. If you don't specify a value forDBParameterGroupName
property, the default DB parameter group for the specified engine and engine version is used. - db
Security List<String>Groups - A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template. If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups. If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations: +
AllocatedStorage
+AutoMinorVersionUpgrade
+AvailabilityZone
+BackupRetentionPeriod
+CharacterSetName
+DBInstanceClass
+DBName
+DBParameterGroupName
+DBSecurityGroups
+DBSubnetGroupName
+Engine
+EngineVersion
+Iops
+LicenseModel
+MasterUsername
+MasterUserPassword
+MultiAZ
+OptionGroupName
+PreferredBackupWindow
+PreferredMaintenanceWindow
All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such asStorageType
,StorageEncrypted
, orKmsKeyId
. If you're already using theDBSecurityGroups
property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance. - db
Snapshot StringIdentifier - The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot. By specifying this property, you can create a DB instance from the specified DB snapshot. If the
DBSnapshotIdentifier
property is an empty string or theAWS::RDS::DBInstance
declaration has noDBSnapshotIdentifier
property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack. Some DB instance properties aren't valid when you restore from a snapshot, such as theMasterUsername
andMasterUserPassword
properties. For information about the properties that you can specify, see theRestoreDBInstanceFromDBSnapshot
action in the Amazon RDS API Reference. After you restore a DB instance with aDBSnapshotIdentifier
property, you must specify the sameDBSnapshotIdentifier
property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify theDBSnapshotIdentifier
property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specifiedDBSnapshotIdentifier
property, and the original DB instance is deleted. If you specify theDBSnapshotIdentifier
property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties: +CharacterSetName
+DBClusterIdentifier
+DBName
+DeleteAutomatedBackups
+EnablePerformanceInsights
+KmsKeyId
+MasterUsername
+MasterUserPassword
+PerformanceInsightsKMSKeyId
+PerformanceInsightsRetentionPeriod
+PromotionTier
+SourceDBInstanceIdentifier
+SourceRegion
+StorageEncrypted
(for an encrypted snapshot) +Timezone
Amazon Aurora Not applicable. Snapshot restore is managed by the DB cluster. - db
Subnet StringGroup Name - A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC. If there's no DB subnet group, then the DB instance isn't a VPC DB instance. For more information about using Amazon RDS in a VPC, see Using Amazon RDS with Amazon Virtual Private Cloud (VPC) in the Amazon RDS User Guide. Amazon Aurora Not applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
- db
System StringId - The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term 'Oracle database instance' refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to
RDSCDB
. The Oracle SID is also the name of your CDB. - dbi
Resource StringId - Property dbiResourceId
- dedicated
Log BooleanVolume - Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
- delete
Automated BooleanBackups - A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted. Amazon Aurora Not applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted.
- deletion
Protection Boolean - A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance. Amazon Aurora Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see
CreateDBCluster
. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster. - domain String
- The Active Directory directory ID to create the DB instance in. Currently, only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see Kerberos Authentication in the Amazon RDS User Guide.
- domain
Auth StringSecret Arn - The ARN for the Secrets Manager secret with the credentials for the user joining the domain. Example:
arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
- domain
Dns List<String>Ips - The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers. Constraints: + 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. Example:
123.124.125.126,234.235.236.237
- domain
Fqdn String - The fully qualified domain name (FQDN) of an Active Directory domain. Constraints: + Can't be longer than 64 characters. Example:
mymanagedADtest.mymanagedAD.mydomain
- domain
IAMRole StringName - The name of the IAM role to use when making API calls to the Directory Service. This setting doesn't apply to the following DB instances: + Amazon Aurora (The domain is managed by the DB cluster.) + RDS Custom
- domain
Ou String - The Active Directory organizational unit for your DB instance to join. Constraints: + Must be in the distinguished name format. + Can't be longer than 64 characters. Example:
OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain
- enable
Cloudwatch List<String>Logs Exports - The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service User Guide. Amazon Aurora Not applicable. CloudWatch Logs exports are managed by the DB cluster. Db2 Valid values:
diag.log
,notify.log
MariaDB Valid values:audit
,error
,general
,slowquery
Microsoft SQL Server Valid values:agent
,error
MySQL Valid values:audit
,error
,general
,slowquery
Oracle Valid values:alert
,audit
,listener
,trace
,oemagent
PostgreSQL Valid values:postgresql
,upgrade
- enable
IAMDatabase BooleanAuthentication - A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see IAM Database Authentication for MariaDB, MySQL, and PostgreSQL in the Amazon RDS User Guide. Amazon Aurora Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
- enable
Performance BooleanInsights - Specifies whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom DB instances.
- endpoint Property Map
- The connection endpoint for the DB instance. The endpoint might not be shown for instances with the status of
creating
. This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions: +CreateDBInstance
+DescribeDBInstances
+DeleteDBInstance
For the data structure that represents Amazon Aurora DB cluster endpoints, seeDBClusterEndpoint
. - engine String
- The name of the database engine to use for this DB instance. Not every database engine is available in every AWS Region. This property is required when creating a DB instance. You can change the architecture of an Oracle database from the non-container database (CDB) architecture to the CDB architecture by updating the
Engine
value in your templates fromoracle-ee
ororacle-ee-cdb
tooracle-se2-cdb
. Converting to the CDB architecture requires an interruption. Valid Values: +aurora-mysql
(for Aurora MySQL DB instances) +aurora-postgresql
(for Aurora PostgreSQL DB instances) +custom-oracle-ee
(for RDS Custom for Oracle DB instances) +custom-oracle-ee-cdb
(for RDS Custom for Oracle DB instances) +custom-sqlserver-ee
(for RDS Custom for SQL Server DB instances) +custom-sqlserver-se
(for RDS Custom for SQL Server DB instances) +custom-sqlserver-web
(for RDS Custom for SQL Server DB instances) +db2-ae
+db2-se
+mariadb
+mysql
+oracle-ee
+oracle-ee-cdb
+oracle-se2
+oracle-se2-cdb
+postgres
+sqlserver-ee
+sqlserver-se
+sqlserver-ex
+sqlserver-web
- engine
Version String - The version number of the database engine to use. For a list of valid engine versions, use the
DescribeDBEngineVersions
action. The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region. Amazon Aurora Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. Db2 See Amazon RDS for Db2 in the Amazon RDS User Guide. MariaDB See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide. Microsoft SQL Server See Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide. MySQL See MySQL on Amazon RDS Versions in the Amazon RDS User Guide. Oracle See Oracle Database Engine Release Notes in the Amazon RDS User Guide. PostgreSQL See Supported PostgreSQL Database Versions in the Amazon RDS User Guide. - iops Number
- The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide. If you specify
io1
for theStorageType
property, then you must also specify theIops
property. Constraints: + For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance. + For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance. - kms
Key StringId - The ARN of the AWS KMS key that's used to encrypt the DB instance, such as
arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef
. If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default KMS key. If you specify this property, you must set the StorageEncrypted property to true. If you specify theSourceDBInstanceIdentifier
property, the value is inherited from the source DB instance if the read replica is created in the same region. If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region. If you specify theSnapshotIdentifier
property, theStorageEncrypted
property value is inherited from the snapshot, and if the DB instance is encrypted, the specifiedKmsKeyId
property is used. If you specifyDBSecurityGroups
, AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see Using Amazon RDS with Amazon VPC in the Amazon RDS User Guide. Amazon Aurora Not applicable. The KMS key identifier is managed by the DB cluster. - license
Model String - License model information for this DB instance. Valid Values: + Aurora MySQL -
general-public-license
+ Aurora PostgreSQL -postgresql-license
+ RDS for Db2 -bring-your-own-license
. For more information about RDS for Db2 licensing, see in the Amazon RDS User Guide. + 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
orlicense-included
+ RDS for PostgreSQL -postgresql-license
If you've specifiedDBSecurityGroups
and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability. - manage
Master BooleanUser Password - Specifies whether to manage the master user password with AWS Secrets Manager. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide. Constraints: + Can't manage the master user password with AWS Secrets Manager if
MasterUserPassword
is specified. - master
User StringPassword - The password for the master user. The password can include any printable ASCII character except '/', ''', or '@'. Amazon Aurora Not applicable. The password for the master user is managed by the DB cluster. RDS for Db2 Must contain from 8 to 255 characters. RDS for MariaDB Constraints: Must contain from 8 to 41 characters. RDS for Microsoft SQL Server Constraints: Must contain from 8 to 128 characters. RDS for MySQL Constraints: Must contain from 8 to 41 characters. RDS for Oracle Constraints: Must contain from 8 to 30 characters. RDS for PostgreSQL Constraints: Must contain from 8 to 128 characters.
- master
User Property MapSecret - The secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide. The
MasterUserSecret
return value specifies the secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide and Password management with Secrets Manager in the Amazon Aurora User Guide. - master
Username String - The master user name for the DB instance. If you specify the
SourceDBInstanceIdentifier
orDBSnapshotIdentifier
property, don't specify this property. The value is inherited from the source DB instance or snapshot. When migrating a self-managed Db2 database, we recommend that you use the same master username as your self-managed Db2 instance name. Amazon Aurora Not applicable. The name for the master user is managed by the DB cluster. RDS for Db2 Constraints: + Must be 1 to 16 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for MariaDB Constraints: + Must be 1 to 16 letters or numbers. + Can't be a reserved word for the chosen database engine. RDS for Microsoft SQL Server Constraints: + Must be 1 to 128 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for MySQL Constraints: + Must be 1 to 16 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for Oracle Constraints: + Must be 1 to 30 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. RDS for PostgreSQL Constraints: + Must be 1 to 63 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. - max
Allocated NumberStorage - The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide. This setting doesn't apply to the following DB instances: + Amazon Aurora (Storage is managed by the DB cluster.) + RDS Custom
- monitoring
Interval Number - The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0. If
MonitoringRoleArn
is specified, then you must setMonitoringInterval
to a value other than 0. This setting doesn't apply to RDS Custom. 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 Amazon CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide. IfMonitoringInterval
is set to a value other than0
, then you must supply aMonitoringRoleArn
value. This setting doesn't apply to RDS Custom DB instances. - multi
AZ Boolean - Specifies whether the database instance is a Multi-AZ DB instance deployment. You can't set the
AvailabilityZone
parameter if theMultiAZ
parameter is set to true. For more information, see Multi-AZ deployments for high availability in the Amazon RDS User Guide. Amazon Aurora Not applicable. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require theMultiAZ
option to be set. - nchar
Character StringSet Name - The name of the NCHAR character set for the Oracle DB instance. This setting doesn't apply to RDS Custom DB instances.
- network
Type String - The network type of the DB instance. Valid values: +
IPV4
+DUAL
The network type is determined by theDBSubnetGroup
specified for the DB instance. ADBSubnetGroup
can support only the IPv4 protocol or the IPv4 and IPv6 protocols (DUAL
). For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide. - option
Group StringName - Indicates that the DB instance should be associated with the specified option group. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance.
- performance
Insights StringKMSKey Id - The AWS KMS key identifier for encryption of Performance Insights data. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for
PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region. For information about enabling Performance Insights, see EnablePerformanceInsights. - performance
Insights NumberRetention Period - The number of days to retain Performance Insights data. This setting doesn't apply to RDS Custom DB instances. Valid Values: +
7
+ month * 31, where month is a number of months from 1-23. Examples:93
(3 months * 31),341
(11 months * 31),589
(19 months * 31) +731
Default:7
days If you specify a retention period that isn't valid, such as94
, Amazon RDS returns an error. - port String
- The port number on which the database accepts connections. Amazon Aurora Not applicable. The port number is managed by the DB cluster. Db2 Default value:
50000
- preferred
Backup StringWindow - The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod
parameter. For more information, see Backup Window in the Amazon RDS User Guide. Constraints: + Must be in the formathh24:mi-hh24:mi
. + Must be in Universal Coordinated Time (UTC). + Must not conflict with the preferred maintenance window. + Must be at least 30 minutes. Amazon Aurora Not applicable. The daily time range for creating automated backups is managed by the DB cluster. - preferred
Maintenance StringWindow - The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format:
ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window in the Amazon RDS User Guide. This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately. Constraints: Minimum 30-minute window. - processor
Features List<Property Map> - The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
- promotion
Tier Number - The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide. This setting doesn't apply to RDS Custom DB instances. Default:
1
Valid Values:0 - 15
- publicly
Accessible Boolean - Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address. The default behavior value depends on your VPC setup and the database subnet group. For more information, see the
PubliclyAccessible
parameter in the CreateDBInstance in the Amazon RDS API Reference. - replica
Mode String - The open mode of an Oracle read replica. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide. This setting is only supported in RDS for Oracle. Default:
open-read-only
Valid Values:open-read-only
ormounted
- restore
Time String - The date and time to restore from. Constraints: + Must be a time in Universal Coordinated Time (UTC) format. + Must be before the latest restorable time for the DB instance. + Can't be specified if the
UseLatestRestorableTime
parameter is enabled. Example:2009-09-07T23:45:00Z
- source
DBCluster StringIdentifier - The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas. Constraints: + Must be the identifier of an existing Multi-AZ DB cluster. + Can't be specified if the
SourceDBInstanceIdentifier
parameter is also specified. + The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0. + The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported. - source
DBInstance StringAutomated Backups Arn - The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example,
arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE
. This setting doesn't apply to RDS Custom. - source
DBInstance StringIdentifier - If you want to create a read replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of read replicas. For more information, see Working with Read Replicas in the Amazon RDS User Guide. For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide. The
SourceDBInstanceIdentifier
property determines whether a DB instance is a read replica. If you remove theSourceDBInstanceIdentifier
property from your template and then update your stack, AWS CloudFormation promotes the Read Replica to a standalone DB instance. + If you specify a source DB instance that uses VPC security groups, we recommend that you specify theVPCSecurityGroups
property. If you don't specify the property, the read replica inherits the value of theVPCSecurityGroups
property from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica'sVPCSecurityGroups
property to the default value because it's not defined in the stack's template. This change might cause unexpected issues. + Read replicas don't support deletion policies. AWS CloudFormation ignores any deletion policy that's associated with a read replica. + If you specifySourceDBInstanceIdentifier
, don't specify theDBSnapshotIdentifier
property. You can't create a read replica from a snapshot. + Don't set theBackupRetentionPeriod
,DBName
,MasterUsername
,MasterUserPassword
, andPreferredBackupWindow
properties. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas. + If the source DB instance is in a different region than the read replica, specify the source region inSourceRegion
, and specify an ARN for a valid DB instance inSourceDBInstanceIdentifier
. For more information, see Constructing a Amazon RDS Amazon Resource Name (ARN) in the Amazon RDS User Guide. + For DB instances in Amazon Aurora clusters, don't specify this property. Amazon RDS automatically assigns writer and reader DB instances. - source
Dbi StringResource Id - The resource ID of the source DB instance from which to restore.
- source
Region String - The ID of the region that contains the source DB instance for the read replica.
- storage
Encrypted Boolean - A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. If you specify the
KmsKeyId
property, then you must enable encryption. If you specify theSourceDBInstanceIdentifier
property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specifiedKmsKeyId
property is used. If you specify theDBSnapshotIdentifier
and the specified snapshot is encrypted, don't specify this property. The value is inherited from the snapshot, and the specifiedKmsKeyId
property is used. If you specify theDBSnapshotIdentifier
and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB instance is encrypted. Specify theKmsKeyId
property for the KMS key to use for encryption. If you don't want the restored DB instance to be encrypted, then don't set this property or set it tofalse
. Amazon Aurora Not applicable. The encryption for DB instances is managed by the DB cluster. - storage
Throughput Number - Specifies the storage throughput value for the DB instance. This setting applies only to the
gp3
storage type. This setting doesn't apply to RDS Custom or Amazon Aurora. - storage
Type String - The storage type to associate with the DB instance. If you specify
io1
,io2
, orgp3
, you must also include a value for theIops
parameter. This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster. Valid Values:gp2 | gp3 | io1 | io2 | standard
Default:io1
, if theIops
parameter is specified. Otherwise,gp2
. - List<Property Map>
- An optional array of key-value pairs to apply to this DB instance.
- tde
Credential StringArn - Property tdeCredentialArn
- tde
Credential StringPassword - Property tdeCredentialPassword
- timezone String
- The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.
- use
Default BooleanProcessor Features - Specifies whether the DB instance class of the DB instance uses its default processor features. This setting doesn't apply to RDS Custom DB instances.
- use
Latest BooleanRestorable Time - Specifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time. Constraints: + Can't be specified if the
RestoreTime
parameter is provided. - vpc
Security List<String>Groups - A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to AWS::EC2::SecurityGroup resources created in the template. If you plan to update the resource, don't specify VPC security groups in a shared VPC. If you set
VPCSecurityGroups
, you must not set DBSecurityGroups, and vice versa. You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind: + You can't revert to using an RDS security group after you establish a VPC security group membership. + When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group. + To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the DBSecurityGroups property. To avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template. Amazon Aurora Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
CertificateDetails, CertificateDetailsArgs
- Ca
Identifier string - The CA identifier of the CA certificate used for the DB instance's server certificate.
- Valid
Till string - The expiration date of the DB instance’s server certificate.
- Ca
Identifier string - The CA identifier of the CA certificate used for the DB instance's server certificate.
- Valid
Till string - The expiration date of the DB instance’s server certificate.
- ca
Identifier String - The CA identifier of the CA certificate used for the DB instance's server certificate.
- valid
Till String - The expiration date of the DB instance’s server certificate.
- ca
Identifier string - The CA identifier of the CA certificate used for the DB instance's server certificate.
- valid
Till string - The expiration date of the DB instance’s server certificate.
- ca_
identifier str - The CA identifier of the CA certificate used for the DB instance's server certificate.
- valid_
till str - The expiration date of the DB instance’s server certificate.
- ca
Identifier String - The CA identifier of the CA certificate used for the DB instance's server certificate.
- valid
Till String - The expiration date of the DB instance’s server certificate.
CertificateDetailsResponse, CertificateDetailsResponseArgs
- Ca
Identifier string - The CA identifier of the CA certificate used for the DB instance's server certificate.
- Valid
Till string - The expiration date of the DB instance’s server certificate.
- Ca
Identifier string - The CA identifier of the CA certificate used for the DB instance's server certificate.
- Valid
Till string - The expiration date of the DB instance’s server certificate.
- ca
Identifier String - The CA identifier of the CA certificate used for the DB instance's server certificate.
- valid
Till String - The expiration date of the DB instance’s server certificate.
- ca
Identifier string - The CA identifier of the CA certificate used for the DB instance's server certificate.
- valid
Till string - The expiration date of the DB instance’s server certificate.
- ca_
identifier str - The CA identifier of the CA certificate used for the DB instance's server certificate.
- valid_
till str - The expiration date of the DB instance’s server certificate.
- ca
Identifier String - The CA identifier of the CA certificate used for the DB instance's server certificate.
- valid
Till String - The expiration date of the DB instance’s server certificate.
DBInstanceRole, DBInstanceRoleArgs
- Feature
Name string - The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf. For the list of supported feature names, see the
SupportedFeatureNames
description in DBEngineVersion in the Amazon RDS API Reference. - Role
Arn string - The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
- Feature
Name string - The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf. For the list of supported feature names, see the
SupportedFeatureNames
description in DBEngineVersion in the Amazon RDS API Reference. - Role
Arn string - The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
- feature
Name String - The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf. For the list of supported feature names, see the
SupportedFeatureNames
description in DBEngineVersion in the Amazon RDS API Reference. - role
Arn String - The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
- feature
Name string - The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf. For the list of supported feature names, see the
SupportedFeatureNames
description in DBEngineVersion in the Amazon RDS API Reference. - role
Arn string - The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
- feature_
name str - The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf. For the list of supported feature names, see the
SupportedFeatureNames
description in DBEngineVersion in the Amazon RDS API Reference. - role_
arn str - The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
- feature
Name String - The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf. For the list of supported feature names, see the
SupportedFeatureNames
description in DBEngineVersion in the Amazon RDS API Reference. - role
Arn String - The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
DBInstanceRoleResponse, DBInstanceRoleResponseArgs
- Feature
Name string - The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf. For the list of supported feature names, see the
SupportedFeatureNames
description in DBEngineVersion in the Amazon RDS API Reference. - Role
Arn string - The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
- Feature
Name string - The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf. For the list of supported feature names, see the
SupportedFeatureNames
description in DBEngineVersion in the Amazon RDS API Reference. - Role
Arn string - The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
- feature
Name String - The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf. For the list of supported feature names, see the
SupportedFeatureNames
description in DBEngineVersion in the Amazon RDS API Reference. - role
Arn String - The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
- feature
Name string - The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf. For the list of supported feature names, see the
SupportedFeatureNames
description in DBEngineVersion in the Amazon RDS API Reference. - role
Arn string - The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
- feature_
name str - The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf. For the list of supported feature names, see the
SupportedFeatureNames
description in DBEngineVersion in the Amazon RDS API Reference. - role_
arn str - The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
- feature
Name String - The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf. For the list of supported feature names, see the
SupportedFeatureNames
description in DBEngineVersion in the Amazon RDS API Reference. - role
Arn String - The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
MasterUserSecret, MasterUserSecretArgs
- kms_
key_ strid - The AWS KMS key identifier that is used to encrypt the secret.
- secret_
arn str - The Amazon Resource Name (ARN) of the secret.
MasterUserSecretResponse, MasterUserSecretResponseArgs
- kms_
key_ strid - The AWS KMS key identifier that is used to encrypt the secret.
- secret_
arn str - The Amazon Resource Name (ARN) of the secret.
ProcessorFeature, ProcessorFeatureArgs
- Name
string | Pulumi.
Azure Native. Aws Connector. Processor Feature Name - Value string
- Name
string | Processor
Feature Name - Value string
- name
String | Processor
Feature Name - value String
- name
string | Processor
Feature Name - value string
- name
str | Processor
Feature Name - value str
- name
String | "core
Count" | "threads Per Core" - value String
ProcessorFeatureName, ProcessorFeatureNameArgs
- Core
Count - coreCountProcessorFeatureName enum coreCount
- Threads
Per Core - threadsPerCoreProcessorFeatureName enum threadsPerCore
- Processor
Feature Name Core Count - coreCountProcessorFeatureName enum coreCount
- Processor
Feature Name Threads Per Core - threadsPerCoreProcessorFeatureName enum threadsPerCore
- Core
Count - coreCountProcessorFeatureName enum coreCount
- Threads
Per Core - threadsPerCoreProcessorFeatureName enum threadsPerCore
- Core
Count - coreCountProcessorFeatureName enum coreCount
- Threads
Per Core - threadsPerCoreProcessorFeatureName enum threadsPerCore
- CORE_COUNT
- coreCountProcessorFeatureName enum coreCount
- THREADS_PER_CORE
- threadsPerCoreProcessorFeatureName enum threadsPerCore
- "core
Count" - coreCountProcessorFeatureName enum coreCount
- "threads
Per Core" - threadsPerCoreProcessorFeatureName enum threadsPerCore
ProcessorFeatureResponse, ProcessorFeatureResponseArgs
RdsDBInstanceProperties, RdsDBInstancePropertiesArgs
- Arn string
- Amazon Resource Name (ARN)
- Aws
Account stringId - AWS Account ID
- Aws
Properties Pulumi.Azure Native. Aws Connector. Inputs. Aws Rds DBInstance Properties - AWS Properties
- Aws
Region string - AWS Region
- Aws
Source stringSchema - AWS Source Schema
- Dictionary<string, string>
- AWS Tags
- Public
Cloud stringConnectors Resource Id - Public Cloud Connectors Resource ID
- Public
Cloud stringResource Name - Public Cloud Resource Name
- Arn string
- Amazon Resource Name (ARN)
- Aws
Account stringId - AWS Account ID
- Aws
Properties AwsRds DBInstance Properties - AWS Properties
- Aws
Region string - AWS Region
- Aws
Source stringSchema - AWS Source Schema
- map[string]string
- AWS Tags
- Public
Cloud stringConnectors Resource Id - Public Cloud Connectors Resource ID
- Public
Cloud stringResource Name - Public Cloud Resource Name
- arn String
- Amazon Resource Name (ARN)
- aws
Account StringId - AWS Account ID
- aws
Properties AwsRds DBInstance Properties - AWS Properties
- aws
Region String - AWS Region
- aws
Source StringSchema - AWS Source Schema
- Map<String,String>
- AWS Tags
- public
Cloud StringConnectors Resource Id - Public Cloud Connectors Resource ID
- public
Cloud StringResource Name - Public Cloud Resource Name
- arn string
- Amazon Resource Name (ARN)
- aws
Account stringId - AWS Account ID
- aws
Properties AwsRds DBInstance Properties - AWS Properties
- aws
Region string - AWS Region
- aws
Source stringSchema - AWS Source Schema
- {[key: string]: string}
- AWS Tags
- public
Cloud stringConnectors Resource Id - Public Cloud Connectors Resource ID
- public
Cloud stringResource Name - Public Cloud Resource Name
- arn str
- Amazon Resource Name (ARN)
- aws_
account_ strid - AWS Account ID
- aws_
properties AwsRds DBInstance Properties - AWS Properties
- aws_
region str - AWS Region
- aws_
source_ strschema - AWS Source Schema
- Mapping[str, str]
- AWS Tags
- public_
cloud_ strconnectors_ resource_ id - Public Cloud Connectors Resource ID
- public_
cloud_ strresource_ name - Public Cloud Resource Name
- arn String
- Amazon Resource Name (ARN)
- aws
Account StringId - AWS Account ID
- aws
Properties Property Map - AWS Properties
- aws
Region String - AWS Region
- aws
Source StringSchema - AWS Source Schema
- Map<String>
- AWS Tags
- public
Cloud StringConnectors Resource Id - Public Cloud Connectors Resource ID
- public
Cloud StringResource Name - Public Cloud Resource Name
RdsDBInstancePropertiesResponse, RdsDBInstancePropertiesResponseArgs
- Provisioning
State string - The status of the last operation.
- Arn string
- Amazon Resource Name (ARN)
- Aws
Account stringId - AWS Account ID
- Aws
Properties Pulumi.Azure Native. Aws Connector. Inputs. Aws Rds DBInstance Properties Response - AWS Properties
- Aws
Region string - AWS Region
- Aws
Source stringSchema - AWS Source Schema
- Dictionary<string, string>
- AWS Tags
- Public
Cloud stringConnectors Resource Id - Public Cloud Connectors Resource ID
- Public
Cloud stringResource Name - Public Cloud Resource Name
- Provisioning
State string - The status of the last operation.
- Arn string
- Amazon Resource Name (ARN)
- Aws
Account stringId - AWS Account ID
- Aws
Properties AwsRds DBInstance Properties Response - AWS Properties
- Aws
Region string - AWS Region
- Aws
Source stringSchema - AWS Source Schema
- map[string]string
- AWS Tags
- Public
Cloud stringConnectors Resource Id - Public Cloud Connectors Resource ID
- Public
Cloud stringResource Name - Public Cloud Resource Name
- provisioning
State String - The status of the last operation.
- arn String
- Amazon Resource Name (ARN)
- aws
Account StringId - AWS Account ID
- aws
Properties AwsRds DBInstance Properties Response - AWS Properties
- aws
Region String - AWS Region
- aws
Source StringSchema - AWS Source Schema
- Map<String,String>
- AWS Tags
- public
Cloud StringConnectors Resource Id - Public Cloud Connectors Resource ID
- public
Cloud StringResource Name - Public Cloud Resource Name
- provisioning
State string - The status of the last operation.
- arn string
- Amazon Resource Name (ARN)
- aws
Account stringId - AWS Account ID
- aws
Properties AwsRds DBInstance Properties Response - AWS Properties
- aws
Region string - AWS Region
- aws
Source stringSchema - AWS Source Schema
- {[key: string]: string}
- AWS Tags
- public
Cloud stringConnectors Resource Id - Public Cloud Connectors Resource ID
- public
Cloud stringResource Name - Public Cloud Resource Name
- provisioning_
state str - The status of the last operation.
- arn str
- Amazon Resource Name (ARN)
- aws_
account_ strid - AWS Account ID
- aws_
properties AwsRds DBInstance Properties Response - AWS Properties
- aws_
region str - AWS Region
- aws_
source_ strschema - AWS Source Schema
- Mapping[str, str]
- AWS Tags
- public_
cloud_ strconnectors_ resource_ id - Public Cloud Connectors Resource ID
- public_
cloud_ strresource_ name - Public Cloud Resource Name
- provisioning
State String - The status of the last operation.
- arn String
- Amazon Resource Name (ARN)
- aws
Account StringId - AWS Account ID
- aws
Properties Property Map - AWS Properties
- aws
Region String - AWS Region
- aws
Source StringSchema - AWS Source Schema
- Map<String>
- AWS Tags
- public
Cloud StringConnectors Resource Id - Public Cloud Connectors Resource ID
- public
Cloud StringResource Name - Public Cloud Resource Name
RdsDbInstanceEndpoint, RdsDbInstanceEndpointArgs
- 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 string
- Specifies the port that the database engine is listening on.
- 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 string
- Specifies the port that the database engine is listening on.
- 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 String
- Specifies the port that the database engine is listening on.
- 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 string
- Specifies the port that the database engine is listening on.
- 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 str
- Specifies the port that the database engine is listening on.
- 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 String
- Specifies the port that the database engine is listening on.
RdsDbInstanceEndpointResponse, RdsDbInstanceEndpointResponseArgs
- 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 string
- Specifies the port that the database engine is listening on.
- 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 string
- Specifies the port that the database engine is listening on.
- 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 String
- Specifies the port that the database engine is listening on.
- 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 string
- Specifies the port that the database engine is listening on.
- 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 str
- Specifies the port that the database engine is listening on.
- 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 String
- Specifies the port that the database engine is listening on.
SystemDataResponse, SystemDataResponseArgs
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - The type of identity that last modified the resource.
- created_
at str - The timestamp of resource creation (UTC).
- created_
by str - The identity that created the resource.
- created_
by_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
Tag, TagArgs
- Key string
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Value string
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Key string
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Value string
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key String
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value String
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key string
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value string
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key str
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value str
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key String
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value String
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
TagResponse, TagResponseArgs
- Key string
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Value string
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Key string
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- Value string
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key String
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value String
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key string
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value string
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key str
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value str
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- key String
- The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- value String
- The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:awsconnector:RdsDbInstance mlawrgduorvzcrxqyngpsq /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/rdsDBInstances/{name}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0