Instance

Provides an RDS instance resource. A DB instance is an isolated database environment in the cloud. A DB instance can contain multiple user-created databases.

Changes to a DB instance can occur when you manually change a parameter, such as allocated_storage, and are reflected in the next maintenance window. Because of this, this provider may report a difference in its planning phase because a modification has not yet taken place. You can use the apply_immediately flag to instruct the service to apply the change immediately (see documentation below).

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

Note: using apply_immediately can result in a brief downtime as the server reboots. See the AWS Docs on [RDS Maintenance][2] for more information.
Note: All arguments including the username and password will be stored in the raw state as plain-text.

RDS Instance Class Types

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

Example Usage

Basic Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var @default = new Aws.Rds.Instance("default", new Aws.Rds.InstanceArgs
        {
            AllocatedStorage = 20,
            Engine = "mysql",
            EngineVersion = "5.7",
            InstanceClass = "db.t2.micro",
            Name = "mydb",
            ParameterGroupName = "default.mysql5.7",
            Password = "foobarbaz",
            StorageType = "gp2",
            Username = "foo",
        });
    }

}

package main

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := rds.NewInstance(ctx, "_default", &rds.InstanceArgs{
            AllocatedStorage:   pulumi.Int(20),
            Engine:             pulumi.String("mysql"),
            EngineVersion:      pulumi.String("5.7"),
            InstanceClass:      pulumi.String("db.t2.micro"),
            Name:               pulumi.String("mydb"),
            ParameterGroupName: pulumi.String("default.mysql5.7"),
            Password:           pulumi.String("foobarbaz"),
            StorageType:        pulumi.String("gp2"),
            Username:           pulumi.String("foo"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

default = aws.rds.Instance("default",
    allocated_storage=20,
    engine="mysql",
    engine_version="5.7",
    instance_class="db.t2.micro",
    name="mydb",
    parameter_group_name="default.mysql5.7",
    password="foobarbaz",
    storage_type="gp2",
    username="foo")

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

const defaultInstance = new aws.rds.Instance("default", {
    allocatedStorage: 20,
    engine: "mysql",
    engineVersion: "5.7",
    instanceClass: "db.t2.micro",
    name: "mydb",
    parameterGroupName: "default.mysql5.7",
    password: "foobarbaz",
    storageType: "gp2",
    username: "foo",
});

Storage Autoscaling

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.Rds.Instance("example", new Aws.Rds.InstanceArgs
        {
            AllocatedStorage = 50,
            MaxAllocatedStorage = 100,
        });
    }

}

package main

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := rds.NewInstance(ctx, "example", &rds.InstanceArgs{
            AllocatedStorage:    pulumi.Int(50),
            MaxAllocatedStorage: pulumi.Int(100),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

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

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

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

Create a Instance Resource

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

def Instance(resource_name, opts=None, allocated_storage=None, allow_major_version_upgrade=None, apply_immediately=None, auto_minor_version_upgrade=None, availability_zone=None, backup_retention_period=None, backup_window=None, ca_cert_identifier=None, character_set_name=None, copy_tags_to_snapshot=None, db_subnet_group_name=None, delete_automated_backups=None, deletion_protection=None, domain=None, domain_iam_role_name=None, enabled_cloudwatch_logs_exports=None, engine=None, engine_version=None, final_snapshot_identifier=None, iam_database_authentication_enabled=None, identifier=None, identifier_prefix=None, instance_class=None, iops=None, kms_key_id=None, license_model=None, maintenance_window=None, max_allocated_storage=None, monitoring_interval=None, monitoring_role_arn=None, multi_az=None, name=None, option_group_name=None, parameter_group_name=None, password=None, performance_insights_enabled=None, performance_insights_kms_key_id=None, performance_insights_retention_period=None, port=None, publicly_accessible=None, replicate_source_db=None, s3_import=None, security_group_names=None, skip_final_snapshot=None, snapshot_identifier=None, storage_encrypted=None, storage_type=None, tags=None, timezone=None, username=None, vpc_security_group_ids=None, __props__=None);

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

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

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

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args InstanceArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

Instance Resource Properties

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

Inputs

The Instance resource accepts the following input properties:

InstanceClass string: The instance type of the RDS instance.
AllocatedStorage int: The allocated storage in gibibytes. If max_allocated_storage is configured, this argument represents the initial storage allocation and differences from the configuration will be ignored automatically when Storage Autoscaling occurs.
AllowMajorVersionUpgrade bool: Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
ApplyImmediately bool: Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.
AutoMinorVersionUpgrade bool: Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaults to true.
AvailabilityZone string: The AZ for the RDS instance.
BackupRetentionPeriod int: The days to retain backups for. Must be between 0 and 35. Must be greater than 0 if the database is used as a source for a Read Replica. [See Read Replica][1].
BackupWindow string: The daily time range (in UTC) during which automated backups are created if they are enabled. Example: “09:46-10:16”. Must not overlap with maintenance_window.
CaCertIdentifier string: The identifier of the CA certificate for the DB instance.
CharacterSetName string: The character set name to use for DB encoding in Oracle and Microsoft SQL instances (collation). This can’t be changed. See Oracle Character Sets Supported in Amazon RDS or Server-Level Collation for Microsoft SQL Server for more information.
CopyTagsToSnapshot bool: Copy all Instance tags to snapshots. Default is false.
DbSubnetGroupName string: Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC, or in EC2 Classic, if available. When working with read replicas, it should be specified only if the source database specifies an instance in another AWS Region. See DBSubnetGroupName in API action CreateDBInstanceReadReplica for additional read replica contraints.
DeleteAutomatedBackups bool: Specifies whether to remove automated backups immediately after the DB instance is deleted. Default is true.
DeletionProtection bool: If the DB instance should have deletion protection enabled. The database can’t be deleted when this value is set to true. The default is false.
Domain string: The ID of the Directory Service Active Directory domain to create the instance in.
DomainIamRoleName string: The name of the IAM role to be used when making API calls to the Directory Service.
EnabledCloudwatchLogsExports List<string>: List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine). MySQL and MariaDB: audit, error, general, slowquery. PostgreSQL: postgresql, upgrade. MSSQL: agent , error. Oracle: alert, audit, listener, trace.
Engine string: (Required unless a snapshot_identifier or replicate_source_db is provided) The database engine to use. For supported values, see the Engine parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine must match the DB cluster’s engine’. For information on the difference between the available Aurora MySQL engines see Comparison between Aurora MySQL 1 and Aurora MySQL 2 in the Amazon RDS User Guide.
EngineVersion string: The engine version to use. If auto_minor_version_upgrade is enabled, you can provide a prefix of the version such as 5.7 (for 5.7.10) and this attribute will ignore differences in the patch version automatically (e.g. 5.7.17). For supported values, see the EngineVersion parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine version must match the DB cluster’s engine version’.
FinalSnapshotIdentifier string: The name of your final DB snapshot when this DB instance is deleted. Must be provided if skip_final_snapshot is set to false.
IamDatabaseAuthenticationEnabled bool: Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
Identifier string: The name of the RDS instance, if omitted, this provider will assign a random, unique identifier.
IdentifierPrefix string: Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
Iops int: The amount of provisioned IOPS. Setting this implies a storage_type of “io1”.
KmsKeyId string: The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.
LicenseModel string: (Optional, but required for some DB engines, i.e. Oracle SE1) License model information for this DB instance.
MaintenanceWindow string: The window to perform maintenance in. Syntax: “ddd:hh24:mi-ddd:hh24:mi”. Eg: “Mon:00:00-Mon:03:00”. See RDS Maintenance Window docs for more information.
MaxAllocatedStorage int: When configured, the upper limit to which Amazon RDS can automatically scale the storage of the DB instance. Configuring this will automatically ignore differences to allocated_storage. Must be greater than or equal to allocated_storage or 0 to disable Storage Autoscaling.
MonitoringInterval int: The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
MonitoringRoleArn string: The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
MultiAz bool: Specifies if the RDS instance is multi-AZ
Name string: The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Note that this does not apply for Oracle or SQL Server engines. See the AWS documentation for more details on what applies for those engines.
OptionGroupName string: Name of the DB option group to associate.
ParameterGroupName string: Name of the DB parameter group to associate.
Password string: (Required unless a snapshot_identifier or replicate_source_db is provided) Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file.
PerformanceInsightsEnabled bool: Specifies whether Performance Insights are enabled. Defaults to false.
PerformanceInsightsKmsKeyId string: The ARN for the KMS key to encrypt Performance Insights data. When specifying performance_insights_kms_key_id, performance_insights_enabled needs to be set to true. Once KMS key is set, it can never be changed.
PerformanceInsightsRetentionPeriod int: The amount of time in days to retain Performance Insights data. Either 7 (7 days) or 731 (2 years). When specifying performance_insights_retention_period, performance_insights_enabled needs to be set to true. Defaults to ‘7’.
Port int: The port on which the DB accepts connections.
PubliclyAccessible bool: Bool to control if instance is publicly accessible. Default is false.
ReplicateSourceDb string: Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate (if replicating within a single region) or ARN of the Amazon RDS Database to replicate (if replicating cross-region). Note that if you are creating a cross-region replica of an encrypted database you will also need to specify a kms_key_id. See [DB Instance Replication][1] and Working with PostgreSQL and MySQL Read Replicas for more information on using Replication.
S3Import InstanceS3ImportArgs: Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance
SecurityGroupNames List<string>: List of DB Security Groups to associate. Only used for DB Instances on the EC2-Classic Platform.
SkipFinalSnapshot bool: Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier. Default is false.
SnapshotIdentifier string: Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you’d find in the RDS console, e.g: rds:production-2015-06-26-06-05.
StorageEncrypted bool: Specifies whether the DB instance is encrypted. Note that if you are creating a cross-region read replica this field is ignored and you should instead declare kms_key_id with a valid ARN. The default is false if not specified.
StorageType string: One of “standard” (magnetic), “gp2” (general purpose SSD), or “io1” (provisioned IOPS SSD). The default is “io1” if iops is specified, “gp2” if not.
Tags Dictionary<string, string>: A map of tags to assign to the resource.
Timezone string: Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information.
Username string: (Required unless a snapshot_identifier or replicate_source_db is provided) Username for the master DB user.
VpcSecurityGroupIds List<string>: List of VPC security groups to associate.

InstanceClass interface{}: The instance type of the RDS instance.
AllocatedStorage int: The allocated storage in gibibytes. If max_allocated_storage is configured, this argument represents the initial storage allocation and differences from the configuration will be ignored automatically when Storage Autoscaling occurs.
AllowMajorVersionUpgrade bool: Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
ApplyImmediately bool: Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.
AutoMinorVersionUpgrade bool: Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaults to true.
AvailabilityZone string: The AZ for the RDS instance.
BackupRetentionPeriod int: The days to retain backups for. Must be between 0 and 35. Must be greater than 0 if the database is used as a source for a Read Replica. [See Read Replica][1].
BackupWindow string: The daily time range (in UTC) during which automated backups are created if they are enabled. Example: “09:46-10:16”. Must not overlap with maintenance_window.
CaCertIdentifier string: The identifier of the CA certificate for the DB instance.
CharacterSetName string: The character set name to use for DB encoding in Oracle and Microsoft SQL instances (collation). This can’t be changed. See Oracle Character Sets Supported in Amazon RDS or Server-Level Collation for Microsoft SQL Server for more information.
CopyTagsToSnapshot bool: Copy all Instance tags to snapshots. Default is false.
DbSubnetGroupName string: Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC, or in EC2 Classic, if available. When working with read replicas, it should be specified only if the source database specifies an instance in another AWS Region. See DBSubnetGroupName in API action CreateDBInstanceReadReplica for additional read replica contraints.
DeleteAutomatedBackups bool: Specifies whether to remove automated backups immediately after the DB instance is deleted. Default is true.
DeletionProtection bool: If the DB instance should have deletion protection enabled. The database can’t be deleted when this value is set to true. The default is false.
Domain string: The ID of the Directory Service Active Directory domain to create the instance in.
DomainIamRoleName string: The name of the IAM role to be used when making API calls to the Directory Service.
EnabledCloudwatchLogsExports []string: List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine). MySQL and MariaDB: audit, error, general, slowquery. PostgreSQL: postgresql, upgrade. MSSQL: agent , error. Oracle: alert, audit, listener, trace.
Engine string: (Required unless a snapshot_identifier or replicate_source_db is provided) The database engine to use. For supported values, see the Engine parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine must match the DB cluster’s engine’. For information on the difference between the available Aurora MySQL engines see Comparison between Aurora MySQL 1 and Aurora MySQL 2 in the Amazon RDS User Guide.
EngineVersion string: The engine version to use. If auto_minor_version_upgrade is enabled, you can provide a prefix of the version such as 5.7 (for 5.7.10) and this attribute will ignore differences in the patch version automatically (e.g. 5.7.17). For supported values, see the EngineVersion parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine version must match the DB cluster’s engine version’.
FinalSnapshotIdentifier string: The name of your final DB snapshot when this DB instance is deleted. Must be provided if skip_final_snapshot is set to false.
IamDatabaseAuthenticationEnabled bool: Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
Identifier string: The name of the RDS instance, if omitted, this provider will assign a random, unique identifier.
IdentifierPrefix string: Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
Iops int: The amount of provisioned IOPS. Setting this implies a storage_type of “io1”.
KmsKeyId string: The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.
LicenseModel string: (Optional, but required for some DB engines, i.e. Oracle SE1) License model information for this DB instance.
MaintenanceWindow string: The window to perform maintenance in. Syntax: “ddd:hh24:mi-ddd:hh24:mi”. Eg: “Mon:00:00-Mon:03:00”. See RDS Maintenance Window docs for more information.
MaxAllocatedStorage int: When configured, the upper limit to which Amazon RDS can automatically scale the storage of the DB instance. Configuring this will automatically ignore differences to allocated_storage. Must be greater than or equal to allocated_storage or 0 to disable Storage Autoscaling.
MonitoringInterval int: The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
MonitoringRoleArn string: The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
MultiAz bool: Specifies if the RDS instance is multi-AZ
Name string: The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Note that this does not apply for Oracle or SQL Server engines. See the AWS documentation for more details on what applies for those engines.
OptionGroupName string: Name of the DB option group to associate.
ParameterGroupName string: Name of the DB parameter group to associate.
Password string: (Required unless a snapshot_identifier or replicate_source_db is provided) Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file.
PerformanceInsightsEnabled bool: Specifies whether Performance Insights are enabled. Defaults to false.
PerformanceInsightsKmsKeyId string: The ARN for the KMS key to encrypt Performance Insights data. When specifying performance_insights_kms_key_id, performance_insights_enabled needs to be set to true. Once KMS key is set, it can never be changed.
PerformanceInsightsRetentionPeriod int: The amount of time in days to retain Performance Insights data. Either 7 (7 days) or 731 (2 years). When specifying performance_insights_retention_period, performance_insights_enabled needs to be set to true. Defaults to ‘7’.
Port int: The port on which the DB accepts connections.
PubliclyAccessible bool: Bool to control if instance is publicly accessible. Default is false.
ReplicateSourceDb string: Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate (if replicating within a single region) or ARN of the Amazon RDS Database to replicate (if replicating cross-region). Note that if you are creating a cross-region replica of an encrypted database you will also need to specify a kms_key_id. See [DB Instance Replication][1] and Working with PostgreSQL and MySQL Read Replicas for more information on using Replication.
S3Import InstanceS3Import: Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance
SecurityGroupNames []string: List of DB Security Groups to associate. Only used for DB Instances on the EC2-Classic Platform.
SkipFinalSnapshot bool: Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier. Default is false.
SnapshotIdentifier string: Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you’d find in the RDS console, e.g: rds:production-2015-06-26-06-05.
StorageEncrypted bool: Specifies whether the DB instance is encrypted. Note that if you are creating a cross-region read replica this field is ignored and you should instead declare kms_key_id with a valid ARN. The default is false if not specified.
StorageType interface{}: One of “standard” (magnetic), “gp2” (general purpose SSD), or “io1” (provisioned IOPS SSD). The default is “io1” if iops is specified, “gp2” if not.
Tags map[string]string: A map of tags to assign to the resource.
Timezone string: Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information.
Username string: (Required unless a snapshot_identifier or replicate_source_db is provided) Username for the master DB user.
VpcSecurityGroupIds []string: List of VPC security groups to associate.

instanceClass string | InstanceType: The instance type of the RDS instance.
allocatedStorage number: The allocated storage in gibibytes. If max_allocated_storage is configured, this argument represents the initial storage allocation and differences from the configuration will be ignored automatically when Storage Autoscaling occurs.
allowMajorVersionUpgrade boolean: Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
applyImmediately boolean: Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.
autoMinorVersionUpgrade boolean: Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaults to true.
availabilityZone string: The AZ for the RDS instance.
backupRetentionPeriod number: The days to retain backups for. Must be between 0 and 35. Must be greater than 0 if the database is used as a source for a Read Replica. [See Read Replica][1].
backupWindow string: The daily time range (in UTC) during which automated backups are created if they are enabled. Example: “09:46-10:16”. Must not overlap with maintenance_window.
caCertIdentifier string: The identifier of the CA certificate for the DB instance.
characterSetName string: The character set name to use for DB encoding in Oracle and Microsoft SQL instances (collation). This can’t be changed. See Oracle Character Sets Supported in Amazon RDS or Server-Level Collation for Microsoft SQL Server for more information.
copyTagsToSnapshot boolean: Copy all Instance tags to snapshots. Default is false.
dbSubnetGroupName string: Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC, or in EC2 Classic, if available. When working with read replicas, it should be specified only if the source database specifies an instance in another AWS Region. See DBSubnetGroupName in API action CreateDBInstanceReadReplica for additional read replica contraints.
deleteAutomatedBackups boolean: Specifies whether to remove automated backups immediately after the DB instance is deleted. Default is true.
deletionProtection boolean: If the DB instance should have deletion protection enabled. The database can’t be deleted when this value is set to true. The default is false.
domain string: The ID of the Directory Service Active Directory domain to create the instance in.
domainIamRoleName string: The name of the IAM role to be used when making API calls to the Directory Service.
enabledCloudwatchLogsExports string[]: List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine). MySQL and MariaDB: audit, error, general, slowquery. PostgreSQL: postgresql, upgrade. MSSQL: agent , error. Oracle: alert, audit, listener, trace.
engine string: (Required unless a snapshot_identifier or replicate_source_db is provided) The database engine to use. For supported values, see the Engine parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine must match the DB cluster’s engine’. For information on the difference between the available Aurora MySQL engines see Comparison between Aurora MySQL 1 and Aurora MySQL 2 in the Amazon RDS User Guide.
engineVersion string: The engine version to use. If auto_minor_version_upgrade is enabled, you can provide a prefix of the version such as 5.7 (for 5.7.10) and this attribute will ignore differences in the patch version automatically (e.g. 5.7.17). For supported values, see the EngineVersion parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine version must match the DB cluster’s engine version’.
finalSnapshotIdentifier string: The name of your final DB snapshot when this DB instance is deleted. Must be provided if skip_final_snapshot is set to false.
iamDatabaseAuthenticationEnabled boolean: Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
identifier string: The name of the RDS instance, if omitted, this provider will assign a random, unique identifier.
identifierPrefix string: Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
iops number: The amount of provisioned IOPS. Setting this implies a storage_type of “io1”.
kmsKeyId string: The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.
licenseModel string: (Optional, but required for some DB engines, i.e. Oracle SE1) License model information for this DB instance.
maintenanceWindow string: The window to perform maintenance in. Syntax: “ddd:hh24:mi-ddd:hh24:mi”. Eg: “Mon:00:00-Mon:03:00”. See RDS Maintenance Window docs for more information.
maxAllocatedStorage number: When configured, the upper limit to which Amazon RDS can automatically scale the storage of the DB instance. Configuring this will automatically ignore differences to allocated_storage. Must be greater than or equal to allocated_storage or 0 to disable Storage Autoscaling.
monitoringInterval number: The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
monitoringRoleArn string: The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
multiAz boolean: Specifies if the RDS instance is multi-AZ
name string: The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Note that this does not apply for Oracle or SQL Server engines. See the AWS documentation for more details on what applies for those engines.
optionGroupName string: Name of the DB option group to associate.
parameterGroupName string: Name of the DB parameter group to associate.
password string: (Required unless a snapshot_identifier or replicate_source_db is provided) Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file.
performanceInsightsEnabled boolean: Specifies whether Performance Insights are enabled. Defaults to false.
performanceInsightsKmsKeyId string: The ARN for the KMS key to encrypt Performance Insights data. When specifying performance_insights_kms_key_id, performance_insights_enabled needs to be set to true. Once KMS key is set, it can never be changed.
performanceInsightsRetentionPeriod number: The amount of time in days to retain Performance Insights data. Either 7 (7 days) or 731 (2 years). When specifying performance_insights_retention_period, performance_insights_enabled needs to be set to true. Defaults to ‘7’.
port number: The port on which the DB accepts connections.
publiclyAccessible boolean: Bool to control if instance is publicly accessible. Default is false.
replicateSourceDb string: Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate (if replicating within a single region) or ARN of the Amazon RDS Database to replicate (if replicating cross-region). Note that if you are creating a cross-region replica of an encrypted database you will also need to specify a kms_key_id. See [DB Instance Replication][1] and Working with PostgreSQL and MySQL Read Replicas for more information on using Replication.
s3Import InstanceS3Import: Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance
securityGroupNames string[]: List of DB Security Groups to associate. Only used for DB Instances on the EC2-Classic Platform.
skipFinalSnapshot boolean: Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier. Default is false.
snapshotIdentifier string: Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you’d find in the RDS console, e.g: rds:production-2015-06-26-06-05.
storageEncrypted boolean: Specifies whether the DB instance is encrypted. Note that if you are creating a cross-region read replica this field is ignored and you should instead declare kms_key_id with a valid ARN. The default is false if not specified.
storageType string | StorageType: One of “standard” (magnetic), “gp2” (general purpose SSD), or “io1” (provisioned IOPS SSD). The default is “io1” if iops is specified, “gp2” if not.
tags {[key: string]: string}: A map of tags to assign to the resource.
timezone string: Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information.
username string: (Required unless a snapshot_identifier or replicate_source_db is provided) Username for the master DB user.
vpcSecurityGroupIds string[]: List of VPC security groups to associate.

instance_class string | str: The instance type of the RDS instance.
allocated_storage float: The allocated storage in gibibytes. If max_allocated_storage is configured, this argument represents the initial storage allocation and differences from the configuration will be ignored automatically when Storage Autoscaling occurs.
allow_major_version_upgrade bool: Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
apply_immediately bool: Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.
auto_minor_version_upgrade bool: Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaults to true.
availability_zone str: The AZ for the RDS instance.
backup_retention_period float: The days to retain backups for. Must be between 0 and 35. Must be greater than 0 if the database is used as a source for a Read Replica. [See Read Replica][1].
backup_window str: The daily time range (in UTC) during which automated backups are created if they are enabled. Example: “09:46-10:16”. Must not overlap with maintenance_window.
ca_cert_identifier str: The identifier of the CA certificate for the DB instance.
character_set_name str: The character set name to use for DB encoding in Oracle and Microsoft SQL instances (collation). This can’t be changed. See Oracle Character Sets Supported in Amazon RDS or Server-Level Collation for Microsoft SQL Server for more information.
copy_tags_to_snapshot bool: Copy all Instance tags to snapshots. Default is false.
db_subnet_group_name str: Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC, or in EC2 Classic, if available. When working with read replicas, it should be specified only if the source database specifies an instance in another AWS Region. See DBSubnetGroupName in API action CreateDBInstanceReadReplica for additional read replica contraints.
delete_automated_backups bool: Specifies whether to remove automated backups immediately after the DB instance is deleted. Default is true.
deletion_protection bool: If the DB instance should have deletion protection enabled. The database can’t be deleted when this value is set to true. The default is false.
domain str: The ID of the Directory Service Active Directory domain to create the instance in.
domain_iam_role_name str: The name of the IAM role to be used when making API calls to the Directory Service.
enabled_cloudwatch_logs_exports List[str]: List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine). MySQL and MariaDB: audit, error, general, slowquery. PostgreSQL: postgresql, upgrade. MSSQL: agent , error. Oracle: alert, audit, listener, trace.
engine str: (Required unless a snapshot_identifier or replicate_source_db is provided) The database engine to use. For supported values, see the Engine parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine must match the DB cluster’s engine’. For information on the difference between the available Aurora MySQL engines see Comparison between Aurora MySQL 1 and Aurora MySQL 2 in the Amazon RDS User Guide.
engine_version str: The engine version to use. If auto_minor_version_upgrade is enabled, you can provide a prefix of the version such as 5.7 (for 5.7.10) and this attribute will ignore differences in the patch version automatically (e.g. 5.7.17). For supported values, see the EngineVersion parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine version must match the DB cluster’s engine version’.
final_snapshot_identifier str: The name of your final DB snapshot when this DB instance is deleted. Must be provided if skip_final_snapshot is set to false.
iam_database_authentication_enabled bool: Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
identifier str: The name of the RDS instance, if omitted, this provider will assign a random, unique identifier.
identifier_prefix str: Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
iops float: The amount of provisioned IOPS. Setting this implies a storage_type of “io1”.
kms_key_id str: The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.
license_model str: (Optional, but required for some DB engines, i.e. Oracle SE1) License model information for this DB instance.
maintenance_window str: The window to perform maintenance in. Syntax: “ddd:hh24:mi-ddd:hh24:mi”. Eg: “Mon:00:00-Mon:03:00”. See RDS Maintenance Window docs for more information.
max_allocated_storage float: When configured, the upper limit to which Amazon RDS can automatically scale the storage of the DB instance. Configuring this will automatically ignore differences to allocated_storage. Must be greater than or equal to allocated_storage or 0 to disable Storage Autoscaling.
monitoring_interval float: The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
monitoring_role_arn str: The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
multi_az bool: Specifies if the RDS instance is multi-AZ
name str: The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Note that this does not apply for Oracle or SQL Server engines. See the AWS documentation for more details on what applies for those engines.
option_group_name str: Name of the DB option group to associate.
parameter_group_name str: Name of the DB parameter group to associate.
password str: (Required unless a snapshot_identifier or replicate_source_db is provided) Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file.
performance_insights_enabled bool: Specifies whether Performance Insights are enabled. Defaults to false.
performance_insights_kms_key_id str: The ARN for the KMS key to encrypt Performance Insights data. When specifying performance_insights_kms_key_id, performance_insights_enabled needs to be set to true. Once KMS key is set, it can never be changed.
performance_insights_retention_period float: The amount of time in days to retain Performance Insights data. Either 7 (7 days) or 731 (2 years). When specifying performance_insights_retention_period, performance_insights_enabled needs to be set to true. Defaults to ‘7’.
port float: The port on which the DB accepts connections.
publicly_accessible bool: Bool to control if instance is publicly accessible. Default is false.
replicate_source_db str: Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate (if replicating within a single region) or ARN of the Amazon RDS Database to replicate (if replicating cross-region). Note that if you are creating a cross-region replica of an encrypted database you will also need to specify a kms_key_id. See [DB Instance Replication][1] and Working with PostgreSQL and MySQL Read Replicas for more information on using Replication.
s3_import Dict[InstanceS3Import]: Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance
security_group_names List[str]: List of DB Security Groups to associate. Only used for DB Instances on the EC2-Classic Platform.
skip_final_snapshot bool: Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier. Default is false.
snapshot_identifier str: Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you’d find in the RDS console, e.g: rds:production-2015-06-26-06-05.
storage_encrypted bool: Specifies whether the DB instance is encrypted. Note that if you are creating a cross-region read replica this field is ignored and you should instead declare kms_key_id with a valid ARN. The default is false if not specified.
storage_type string | str: One of “standard” (magnetic), “gp2” (general purpose SSD), or “io1” (provisioned IOPS SSD). The default is “io1” if iops is specified, “gp2” if not.
tags Dict[str, str]: A map of tags to assign to the resource.
timezone str: Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information.
username str: (Required unless a snapshot_identifier or replicate_source_db is provided) Username for the master DB user.
vpc_security_group_ids List[str]: List of VPC security groups to associate.

Outputs

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

Address string: The hostname of the RDS instance. See also endpoint and port.
Arn string: The ARN of the RDS instance.
Endpoint string: The connection endpoint in address:port format.
HostedZoneId string: The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record).
Id string: The provider-assigned unique ID for this managed resource.
Replicas List<string>
ResourceId string: The RDS Resource ID of this instance.
Status string: The RDS instance status.

Address string: The hostname of the RDS instance. See also endpoint and port.
Arn string: The ARN of the RDS instance.
Endpoint string: The connection endpoint in address:port format.
HostedZoneId string: The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record).
Id string: The provider-assigned unique ID for this managed resource.
Replicas []string
ResourceId string: The RDS Resource ID of this instance.
Status string: The RDS instance status.

address string: The hostname of the RDS instance. See also endpoint and port.
arn string: The ARN of the RDS instance.
endpoint string: The connection endpoint in address:port format.
hostedZoneId string: The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record).
id string: The provider-assigned unique ID for this managed resource.
replicas string[]
resourceId string: The RDS Resource ID of this instance.
status string: The RDS instance status.

address str: The hostname of the RDS instance. See also endpoint and port.
arn str: The ARN of the RDS instance.
endpoint str: The connection endpoint in address:port format.
hosted_zone_id str: The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record).
id str: The provider-assigned unique ID for this managed resource.
replicas List[str]
resource_id str: The RDS Resource ID of this instance.
status str: The RDS instance status.

Look up an Existing Instance Resource

Get an existing Instance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: InstanceState, opts?: CustomResourceOptions): Instance

static get(resource_name, id, opts=None, address=None, allocated_storage=None, allow_major_version_upgrade=None, apply_immediately=None, arn=None, auto_minor_version_upgrade=None, availability_zone=None, backup_retention_period=None, backup_window=None, ca_cert_identifier=None, character_set_name=None, copy_tags_to_snapshot=None, db_subnet_group_name=None, delete_automated_backups=None, deletion_protection=None, domain=None, domain_iam_role_name=None, enabled_cloudwatch_logs_exports=None, endpoint=None, engine=None, engine_version=None, final_snapshot_identifier=None, hosted_zone_id=None, iam_database_authentication_enabled=None, identifier=None, identifier_prefix=None, instance_class=None, iops=None, kms_key_id=None, license_model=None, maintenance_window=None, max_allocated_storage=None, monitoring_interval=None, monitoring_role_arn=None, multi_az=None, name=None, option_group_name=None, parameter_group_name=None, password=None, performance_insights_enabled=None, performance_insights_kms_key_id=None, performance_insights_retention_period=None, port=None, publicly_accessible=None, replicas=None, replicate_source_db=None, resource_id=None, s3_import=None, security_group_names=None, skip_final_snapshot=None, snapshot_identifier=None, status=None, storage_encrypted=None, storage_type=None, tags=None, timezone=None, username=None, vpc_security_group_ids=None, __props__=None);

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

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

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Address string: The hostname of the RDS instance. See also endpoint and port.
AllocatedStorage int: The allocated storage in gibibytes. If max_allocated_storage is configured, this argument represents the initial storage allocation and differences from the configuration will be ignored automatically when Storage Autoscaling occurs.
AllowMajorVersionUpgrade bool: Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
ApplyImmediately bool: Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.
Arn string: The ARN of the RDS instance.
AutoMinorVersionUpgrade bool: Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaults to true.
AvailabilityZone string: The AZ for the RDS instance.
BackupRetentionPeriod int: The days to retain backups for. Must be between 0 and 35. Must be greater than 0 if the database is used as a source for a Read Replica. [See Read Replica][1].
BackupWindow string: The daily time range (in UTC) during which automated backups are created if they are enabled. Example: “09:46-10:16”. Must not overlap with maintenance_window.
CaCertIdentifier string: The identifier of the CA certificate for the DB instance.
CharacterSetName string: The character set name to use for DB encoding in Oracle and Microsoft SQL instances (collation). This can’t be changed. See Oracle Character Sets Supported in Amazon RDS or Server-Level Collation for Microsoft SQL Server for more information.
CopyTagsToSnapshot bool: Copy all Instance tags to snapshots. Default is false.
DbSubnetGroupName string: Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC, or in EC2 Classic, if available. When working with read replicas, it should be specified only if the source database specifies an instance in another AWS Region. See DBSubnetGroupName in API action CreateDBInstanceReadReplica for additional read replica contraints.
DeleteAutomatedBackups bool: Specifies whether to remove automated backups immediately after the DB instance is deleted. Default is true.
DeletionProtection bool: If the DB instance should have deletion protection enabled. The database can’t be deleted when this value is set to true. The default is false.
Domain string: The ID of the Directory Service Active Directory domain to create the instance in.
DomainIamRoleName string: The name of the IAM role to be used when making API calls to the Directory Service.
EnabledCloudwatchLogsExports List<string>: List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine). MySQL and MariaDB: audit, error, general, slowquery. PostgreSQL: postgresql, upgrade. MSSQL: agent , error. Oracle: alert, audit, listener, trace.
Endpoint string: The connection endpoint in address:port format.
Engine string: (Required unless a snapshot_identifier or replicate_source_db is provided) The database engine to use. For supported values, see the Engine parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine must match the DB cluster’s engine’. For information on the difference between the available Aurora MySQL engines see Comparison between Aurora MySQL 1 and Aurora MySQL 2 in the Amazon RDS User Guide.
EngineVersion string: The engine version to use. If auto_minor_version_upgrade is enabled, you can provide a prefix of the version such as 5.7 (for 5.7.10) and this attribute will ignore differences in the patch version automatically (e.g. 5.7.17). For supported values, see the EngineVersion parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine version must match the DB cluster’s engine version’.
FinalSnapshotIdentifier string: The name of your final DB snapshot when this DB instance is deleted. Must be provided if skip_final_snapshot is set to false.
HostedZoneId string: The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record).
IamDatabaseAuthenticationEnabled bool: Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
Identifier string: The name of the RDS instance, if omitted, this provider will assign a random, unique identifier.
IdentifierPrefix string: Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
InstanceClass string: The instance type of the RDS instance.
Iops int: The amount of provisioned IOPS. Setting this implies a storage_type of “io1”.
KmsKeyId string: The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.
LicenseModel string: (Optional, but required for some DB engines, i.e. Oracle SE1) License model information for this DB instance.
MaintenanceWindow string: The window to perform maintenance in. Syntax: “ddd:hh24:mi-ddd:hh24:mi”. Eg: “Mon:00:00-Mon:03:00”. See RDS Maintenance Window docs for more information.
MaxAllocatedStorage int: When configured, the upper limit to which Amazon RDS can automatically scale the storage of the DB instance. Configuring this will automatically ignore differences to allocated_storage. Must be greater than or equal to allocated_storage or 0 to disable Storage Autoscaling.
MonitoringInterval int: The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
MonitoringRoleArn string: The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
MultiAz bool: Specifies if the RDS instance is multi-AZ
Name string: The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Note that this does not apply for Oracle or SQL Server engines. See the AWS documentation for more details on what applies for those engines.
OptionGroupName string: Name of the DB option group to associate.
ParameterGroupName string: Name of the DB parameter group to associate.
Password string: (Required unless a snapshot_identifier or replicate_source_db is provided) Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file.
PerformanceInsightsEnabled bool: Specifies whether Performance Insights are enabled. Defaults to false.
PerformanceInsightsKmsKeyId string: The ARN for the KMS key to encrypt Performance Insights data. When specifying performance_insights_kms_key_id, performance_insights_enabled needs to be set to true. Once KMS key is set, it can never be changed.
PerformanceInsightsRetentionPeriod int: The amount of time in days to retain Performance Insights data. Either 7 (7 days) or 731 (2 years). When specifying performance_insights_retention_period, performance_insights_enabled needs to be set to true. Defaults to ‘7’.
Port int: The port on which the DB accepts connections.
PubliclyAccessible bool: Bool to control if instance is publicly accessible. Default is false.
Replicas List<string>
ReplicateSourceDb string: Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate (if replicating within a single region) or ARN of the Amazon RDS Database to replicate (if replicating cross-region). Note that if you are creating a cross-region replica of an encrypted database you will also need to specify a kms_key_id. See [DB Instance Replication][1] and Working with PostgreSQL and MySQL Read Replicas for more information on using Replication.
ResourceId string: The RDS Resource ID of this instance.
S3Import InstanceS3ImportArgs: Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance
SecurityGroupNames List<string>: List of DB Security Groups to associate. Only used for DB Instances on the EC2-Classic Platform.
SkipFinalSnapshot bool: Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier. Default is false.
SnapshotIdentifier string: Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you’d find in the RDS console, e.g: rds:production-2015-06-26-06-05.
Status string: The RDS instance status.
StorageEncrypted bool: Specifies whether the DB instance is encrypted. Note that if you are creating a cross-region read replica this field is ignored and you should instead declare kms_key_id with a valid ARN. The default is false if not specified.
StorageType string: One of “standard” (magnetic), “gp2” (general purpose SSD), or “io1” (provisioned IOPS SSD). The default is “io1” if iops is specified, “gp2” if not.
Tags Dictionary<string, string>: A map of tags to assign to the resource.
Timezone string: Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information.
Username string: (Required unless a snapshot_identifier or replicate_source_db is provided) Username for the master DB user.
VpcSecurityGroupIds List<string>: List of VPC security groups to associate.

Address string: The hostname of the RDS instance. See also endpoint and port.
AllocatedStorage int: The allocated storage in gibibytes. If max_allocated_storage is configured, this argument represents the initial storage allocation and differences from the configuration will be ignored automatically when Storage Autoscaling occurs.
AllowMajorVersionUpgrade bool: Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
ApplyImmediately bool: Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.
Arn string: The ARN of the RDS instance.
AutoMinorVersionUpgrade bool: Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaults to true.
AvailabilityZone string: The AZ for the RDS instance.
BackupRetentionPeriod int: The days to retain backups for. Must be between 0 and 35. Must be greater than 0 if the database is used as a source for a Read Replica. [See Read Replica][1].
BackupWindow string: The daily time range (in UTC) during which automated backups are created if they are enabled. Example: “09:46-10:16”. Must not overlap with maintenance_window.
CaCertIdentifier string: The identifier of the CA certificate for the DB instance.
CharacterSetName string: The character set name to use for DB encoding in Oracle and Microsoft SQL instances (collation). This can’t be changed. See Oracle Character Sets Supported in Amazon RDS or Server-Level Collation for Microsoft SQL Server for more information.
CopyTagsToSnapshot bool: Copy all Instance tags to snapshots. Default is false.
DbSubnetGroupName string: Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC, or in EC2 Classic, if available. When working with read replicas, it should be specified only if the source database specifies an instance in another AWS Region. See DBSubnetGroupName in API action CreateDBInstanceReadReplica for additional read replica contraints.
DeleteAutomatedBackups bool: Specifies whether to remove automated backups immediately after the DB instance is deleted. Default is true.
DeletionProtection bool: If the DB instance should have deletion protection enabled. The database can’t be deleted when this value is set to true. The default is false.
Domain string: The ID of the Directory Service Active Directory domain to create the instance in.
DomainIamRoleName string: The name of the IAM role to be used when making API calls to the Directory Service.
EnabledCloudwatchLogsExports []string: List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine). MySQL and MariaDB: audit, error, general, slowquery. PostgreSQL: postgresql, upgrade. MSSQL: agent , error. Oracle: alert, audit, listener, trace.
Endpoint string: The connection endpoint in address:port format.
Engine string: (Required unless a snapshot_identifier or replicate_source_db is provided) The database engine to use. For supported values, see the Engine parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine must match the DB cluster’s engine’. For information on the difference between the available Aurora MySQL engines see Comparison between Aurora MySQL 1 and Aurora MySQL 2 in the Amazon RDS User Guide.
EngineVersion string: The engine version to use. If auto_minor_version_upgrade is enabled, you can provide a prefix of the version such as 5.7 (for 5.7.10) and this attribute will ignore differences in the patch version automatically (e.g. 5.7.17). For supported values, see the EngineVersion parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine version must match the DB cluster’s engine version’.
FinalSnapshotIdentifier string: The name of your final DB snapshot when this DB instance is deleted. Must be provided if skip_final_snapshot is set to false.
HostedZoneId string: The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record).
IamDatabaseAuthenticationEnabled bool: Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
Identifier string: The name of the RDS instance, if omitted, this provider will assign a random, unique identifier.
IdentifierPrefix string: Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
InstanceClass interface{}: The instance type of the RDS instance.
Iops int: The amount of provisioned IOPS. Setting this implies a storage_type of “io1”.
KmsKeyId string: The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.
LicenseModel string: (Optional, but required for some DB engines, i.e. Oracle SE1) License model information for this DB instance.
MaintenanceWindow string: The window to perform maintenance in. Syntax: “ddd:hh24:mi-ddd:hh24:mi”. Eg: “Mon:00:00-Mon:03:00”. See RDS Maintenance Window docs for more information.
MaxAllocatedStorage int: When configured, the upper limit to which Amazon RDS can automatically scale the storage of the DB instance. Configuring this will automatically ignore differences to allocated_storage. Must be greater than or equal to allocated_storage or 0 to disable Storage Autoscaling.
MonitoringInterval int: The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
MonitoringRoleArn string: The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
MultiAz bool: Specifies if the RDS instance is multi-AZ
Name string: The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Note that this does not apply for Oracle or SQL Server engines. See the AWS documentation for more details on what applies for those engines.
OptionGroupName string: Name of the DB option group to associate.
ParameterGroupName string: Name of the DB parameter group to associate.
Password string: (Required unless a snapshot_identifier or replicate_source_db is provided) Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file.
PerformanceInsightsEnabled bool: Specifies whether Performance Insights are enabled. Defaults to false.
PerformanceInsightsKmsKeyId string: The ARN for the KMS key to encrypt Performance Insights data. When specifying performance_insights_kms_key_id, performance_insights_enabled needs to be set to true. Once KMS key is set, it can never be changed.
PerformanceInsightsRetentionPeriod int: The amount of time in days to retain Performance Insights data. Either 7 (7 days) or 731 (2 years). When specifying performance_insights_retention_period, performance_insights_enabled needs to be set to true. Defaults to ‘7’.
Port int: The port on which the DB accepts connections.
PubliclyAccessible bool: Bool to control if instance is publicly accessible. Default is false.
Replicas []string
ReplicateSourceDb string: Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate (if replicating within a single region) or ARN of the Amazon RDS Database to replicate (if replicating cross-region). Note that if you are creating a cross-region replica of an encrypted database you will also need to specify a kms_key_id. See [DB Instance Replication][1] and Working with PostgreSQL and MySQL Read Replicas for more information on using Replication.
ResourceId string: The RDS Resource ID of this instance.
S3Import InstanceS3Import: Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance
SecurityGroupNames []string: List of DB Security Groups to associate. Only used for DB Instances on the EC2-Classic Platform.
SkipFinalSnapshot bool: Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier. Default is false.
SnapshotIdentifier string: Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you’d find in the RDS console, e.g: rds:production-2015-06-26-06-05.
Status string: The RDS instance status.
StorageEncrypted bool: Specifies whether the DB instance is encrypted. Note that if you are creating a cross-region read replica this field is ignored and you should instead declare kms_key_id with a valid ARN. The default is false if not specified.
StorageType interface{}: One of “standard” (magnetic), “gp2” (general purpose SSD), or “io1” (provisioned IOPS SSD). The default is “io1” if iops is specified, “gp2” if not.
Tags map[string]string: A map of tags to assign to the resource.
Timezone string: Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information.
Username string: (Required unless a snapshot_identifier or replicate_source_db is provided) Username for the master DB user.
VpcSecurityGroupIds []string: List of VPC security groups to associate.

address string: The hostname of the RDS instance. See also endpoint and port.
allocatedStorage number: The allocated storage in gibibytes. If max_allocated_storage is configured, this argument represents the initial storage allocation and differences from the configuration will be ignored automatically when Storage Autoscaling occurs.
allowMajorVersionUpgrade boolean: Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
applyImmediately boolean: Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.
arn string: The ARN of the RDS instance.
autoMinorVersionUpgrade boolean: Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaults to true.
availabilityZone string: The AZ for the RDS instance.
backupRetentionPeriod number: The days to retain backups for. Must be between 0 and 35. Must be greater than 0 if the database is used as a source for a Read Replica. [See Read Replica][1].
backupWindow string: The daily time range (in UTC) during which automated backups are created if they are enabled. Example: “09:46-10:16”. Must not overlap with maintenance_window.
caCertIdentifier string: The identifier of the CA certificate for the DB instance.
characterSetName string: The character set name to use for DB encoding in Oracle and Microsoft SQL instances (collation). This can’t be changed. See Oracle Character Sets Supported in Amazon RDS or Server-Level Collation for Microsoft SQL Server for more information.
copyTagsToSnapshot boolean: Copy all Instance tags to snapshots. Default is false.
dbSubnetGroupName string: Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC, or in EC2 Classic, if available. When working with read replicas, it should be specified only if the source database specifies an instance in another AWS Region. See DBSubnetGroupName in API action CreateDBInstanceReadReplica for additional read replica contraints.
deleteAutomatedBackups boolean: Specifies whether to remove automated backups immediately after the DB instance is deleted. Default is true.
deletionProtection boolean: If the DB instance should have deletion protection enabled. The database can’t be deleted when this value is set to true. The default is false.
domain string: The ID of the Directory Service Active Directory domain to create the instance in.
domainIamRoleName string: The name of the IAM role to be used when making API calls to the Directory Service.
enabledCloudwatchLogsExports string[]: List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine). MySQL and MariaDB: audit, error, general, slowquery. PostgreSQL: postgresql, upgrade. MSSQL: agent , error. Oracle: alert, audit, listener, trace.
endpoint string: The connection endpoint in address:port format.
engine string: (Required unless a snapshot_identifier or replicate_source_db is provided) The database engine to use. For supported values, see the Engine parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine must match the DB cluster’s engine’. For information on the difference between the available Aurora MySQL engines see Comparison between Aurora MySQL 1 and Aurora MySQL 2 in the Amazon RDS User Guide.
engineVersion string: The engine version to use. If auto_minor_version_upgrade is enabled, you can provide a prefix of the version such as 5.7 (for 5.7.10) and this attribute will ignore differences in the patch version automatically (e.g. 5.7.17). For supported values, see the EngineVersion parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine version must match the DB cluster’s engine version’.
finalSnapshotIdentifier string: The name of your final DB snapshot when this DB instance is deleted. Must be provided if skip_final_snapshot is set to false.
hostedZoneId string: The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record).
iamDatabaseAuthenticationEnabled boolean: Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
identifier string: The name of the RDS instance, if omitted, this provider will assign a random, unique identifier.
identifierPrefix string: Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
instanceClass string | InstanceType: The instance type of the RDS instance.
iops number: The amount of provisioned IOPS. Setting this implies a storage_type of “io1”.
kmsKeyId string: The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.
licenseModel string: (Optional, but required for some DB engines, i.e. Oracle SE1) License model information for this DB instance.
maintenanceWindow string: The window to perform maintenance in. Syntax: “ddd:hh24:mi-ddd:hh24:mi”. Eg: “Mon:00:00-Mon:03:00”. See RDS Maintenance Window docs for more information.
maxAllocatedStorage number: When configured, the upper limit to which Amazon RDS can automatically scale the storage of the DB instance. Configuring this will automatically ignore differences to allocated_storage. Must be greater than or equal to allocated_storage or 0 to disable Storage Autoscaling.
monitoringInterval number: The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
monitoringRoleArn string: The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
multiAz boolean: Specifies if the RDS instance is multi-AZ
name string: The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Note that this does not apply for Oracle or SQL Server engines. See the AWS documentation for more details on what applies for those engines.
optionGroupName string: Name of the DB option group to associate.
parameterGroupName string: Name of the DB parameter group to associate.
password string: (Required unless a snapshot_identifier or replicate_source_db is provided) Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file.
performanceInsightsEnabled boolean: Specifies whether Performance Insights are enabled. Defaults to false.
performanceInsightsKmsKeyId string: The ARN for the KMS key to encrypt Performance Insights data. When specifying performance_insights_kms_key_id, performance_insights_enabled needs to be set to true. Once KMS key is set, it can never be changed.
performanceInsightsRetentionPeriod number: The amount of time in days to retain Performance Insights data. Either 7 (7 days) or 731 (2 years). When specifying performance_insights_retention_period, performance_insights_enabled needs to be set to true. Defaults to ‘7’.
port number: The port on which the DB accepts connections.
publiclyAccessible boolean: Bool to control if instance is publicly accessible. Default is false.
replicas string[]
replicateSourceDb string: Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate (if replicating within a single region) or ARN of the Amazon RDS Database to replicate (if replicating cross-region). Note that if you are creating a cross-region replica of an encrypted database you will also need to specify a kms_key_id. See [DB Instance Replication][1] and Working with PostgreSQL and MySQL Read Replicas for more information on using Replication.
resourceId string: The RDS Resource ID of this instance.
s3Import InstanceS3Import: Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance
securityGroupNames string[]: List of DB Security Groups to associate. Only used for DB Instances on the EC2-Classic Platform.
skipFinalSnapshot boolean: Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier. Default is false.
snapshotIdentifier string: Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you’d find in the RDS console, e.g: rds:production-2015-06-26-06-05.
status string: The RDS instance status.
storageEncrypted boolean: Specifies whether the DB instance is encrypted. Note that if you are creating a cross-region read replica this field is ignored and you should instead declare kms_key_id with a valid ARN. The default is false if not specified.
storageType string | StorageType: One of “standard” (magnetic), “gp2” (general purpose SSD), or “io1” (provisioned IOPS SSD). The default is “io1” if iops is specified, “gp2” if not.
tags {[key: string]: string}: A map of tags to assign to the resource.
timezone string: Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information.
username string: (Required unless a snapshot_identifier or replicate_source_db is provided) Username for the master DB user.
vpcSecurityGroupIds string[]: List of VPC security groups to associate.

address str: The hostname of the RDS instance. See also endpoint and port.
allocated_storage float: The allocated storage in gibibytes. If max_allocated_storage is configured, this argument represents the initial storage allocation and differences from the configuration will be ignored automatically when Storage Autoscaling occurs.
allow_major_version_upgrade bool: Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
apply_immediately bool: Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.
arn str: The ARN of the RDS instance.
auto_minor_version_upgrade bool: Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaults to true.
availability_zone str: The AZ for the RDS instance.
backup_retention_period float: The days to retain backups for. Must be between 0 and 35. Must be greater than 0 if the database is used as a source for a Read Replica. [See Read Replica][1].
backup_window str: The daily time range (in UTC) during which automated backups are created if they are enabled. Example: “09:46-10:16”. Must not overlap with maintenance_window.
ca_cert_identifier str: The identifier of the CA certificate for the DB instance.
character_set_name str: The character set name to use for DB encoding in Oracle and Microsoft SQL instances (collation). This can’t be changed. See Oracle Character Sets Supported in Amazon RDS or Server-Level Collation for Microsoft SQL Server for more information.
copy_tags_to_snapshot bool: Copy all Instance tags to snapshots. Default is false.
db_subnet_group_name str: Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC, or in EC2 Classic, if available. When working with read replicas, it should be specified only if the source database specifies an instance in another AWS Region. See DBSubnetGroupName in API action CreateDBInstanceReadReplica for additional read replica contraints.
delete_automated_backups bool: Specifies whether to remove automated backups immediately after the DB instance is deleted. Default is true.
deletion_protection bool: If the DB instance should have deletion protection enabled. The database can’t be deleted when this value is set to true. The default is false.
domain str: The ID of the Directory Service Active Directory domain to create the instance in.
domain_iam_role_name str: The name of the IAM role to be used when making API calls to the Directory Service.
enabled_cloudwatch_logs_exports List[str]: List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine). MySQL and MariaDB: audit, error, general, slowquery. PostgreSQL: postgresql, upgrade. MSSQL: agent , error. Oracle: alert, audit, listener, trace.
endpoint str: The connection endpoint in address:port format.
engine str: (Required unless a snapshot_identifier or replicate_source_db is provided) The database engine to use. For supported values, see the Engine parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine must match the DB cluster’s engine’. For information on the difference between the available Aurora MySQL engines see Comparison between Aurora MySQL 1 and Aurora MySQL 2 in the Amazon RDS User Guide.
engine_version str: The engine version to use. If auto_minor_version_upgrade is enabled, you can provide a prefix of the version such as 5.7 (for 5.7.10) and this attribute will ignore differences in the patch version automatically (e.g. 5.7.17). For supported values, see the EngineVersion parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine version must match the DB cluster’s engine version’.
final_snapshot_identifier str: The name of your final DB snapshot when this DB instance is deleted. Must be provided if skip_final_snapshot is set to false.
hosted_zone_id str: The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record).
iam_database_authentication_enabled bool: Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
identifier str: The name of the RDS instance, if omitted, this provider will assign a random, unique identifier.
identifier_prefix str: Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
instance_class string | str: The instance type of the RDS instance.
iops float: The amount of provisioned IOPS. Setting this implies a storage_type of “io1”.
kms_key_id str: The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.
license_model str: (Optional, but required for some DB engines, i.e. Oracle SE1) License model information for this DB instance.
maintenance_window str: The window to perform maintenance in. Syntax: “ddd:hh24:mi-ddd:hh24:mi”. Eg: “Mon:00:00-Mon:03:00”. See RDS Maintenance Window docs for more information.
max_allocated_storage float: When configured, the upper limit to which Amazon RDS can automatically scale the storage of the DB instance. Configuring this will automatically ignore differences to allocated_storage. Must be greater than or equal to allocated_storage or 0 to disable Storage Autoscaling.
monitoring_interval float: The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
monitoring_role_arn str: The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
multi_az bool: Specifies if the RDS instance is multi-AZ
name str: The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Note that this does not apply for Oracle or SQL Server engines. See the AWS documentation for more details on what applies for those engines.
option_group_name str: Name of the DB option group to associate.
parameter_group_name str: Name of the DB parameter group to associate.
password str: (Required unless a snapshot_identifier or replicate_source_db is provided) Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file.
performance_insights_enabled bool: Specifies whether Performance Insights are enabled. Defaults to false.
performance_insights_kms_key_id str: The ARN for the KMS key to encrypt Performance Insights data. When specifying performance_insights_kms_key_id, performance_insights_enabled needs to be set to true. Once KMS key is set, it can never be changed.
performance_insights_retention_period float: The amount of time in days to retain Performance Insights data. Either 7 (7 days) or 731 (2 years). When specifying performance_insights_retention_period, performance_insights_enabled needs to be set to true. Defaults to ‘7’.
port float: The port on which the DB accepts connections.
publicly_accessible bool: Bool to control if instance is publicly accessible. Default is false.
replicas List[str]
replicate_source_db str: Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate (if replicating within a single region) or ARN of the Amazon RDS Database to replicate (if replicating cross-region). Note that if you are creating a cross-region replica of an encrypted database you will also need to specify a kms_key_id. See [DB Instance Replication][1] and Working with PostgreSQL and MySQL Read Replicas for more information on using Replication.
resource_id str: The RDS Resource ID of this instance.
s3_import Dict[InstanceS3Import]: Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance
security_group_names List[str]: List of DB Security Groups to associate. Only used for DB Instances on the EC2-Classic Platform.
skip_final_snapshot bool: Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier. Default is false.
snapshot_identifier str: Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you’d find in the RDS console, e.g: rds:production-2015-06-26-06-05.
status str: The RDS instance status.
storage_encrypted bool: Specifies whether the DB instance is encrypted. Note that if you are creating a cross-region read replica this field is ignored and you should instead declare kms_key_id with a valid ARN. The default is false if not specified.
storage_type string | str: One of “standard” (magnetic), “gp2” (general purpose SSD), or “io1” (provisioned IOPS SSD). The default is “io1” if iops is specified, “gp2” if not.
tags Dict[str, str]: A map of tags to assign to the resource.
timezone str: Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information.
username str: (Required unless a snapshot_identifier or replicate_source_db is provided) Username for the master DB user.
vpc_security_group_ids List[str]: List of VPC security groups to associate.

Supporting Types

InstanceS3Import

See the input and output API doc for this type.

BucketName string: The bucket name where your backup is stored
IngestionRole string: Role applied to load the data.
SourceEngine string: Source engine for the backup
SourceEngineVersion string: Version of the source engine used to make the backup
BucketPrefix string: Can be blank, but is the path to your backup

BucketName string: The bucket name where your backup is stored
IngestionRole string: Role applied to load the data.
SourceEngine string: Source engine for the backup
SourceEngineVersion string: Version of the source engine used to make the backup
BucketPrefix string: Can be blank, but is the path to your backup

bucketName string: The bucket name where your backup is stored
ingestionRole string: Role applied to load the data.
sourceEngine string: Source engine for the backup
sourceEngineVersion string: Version of the source engine used to make the backup
bucketPrefix string: Can be blank, but is the path to your backup

bucket_name str: The bucket name where your backup is stored
ingestionRole str: Role applied to load the data.
sourceEngine str: Source engine for the backup
sourceEngineVersion str: Version of the source engine used to make the backup
bucket_prefix str: Can be blank, but is the path to your backup

Package Details

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud