aws.rds.Instance

The allocated storage in gibibytes. If max_allocated_storage is configured, this argument represents the initial storage allocation and differences from the configuration will be ignored automatically when Storage Autoscaling occurs. If replicate_source_db is set, the value is ignored during the creation of the instance.

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.

Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.

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.

BlueGreenUpdate InstanceBlueGreenUpdate

The days to retain backups for. Must be between 0 and 35. Default is 0. Must be greater than 0 if the database is used as a source for a [Read Replica][instance-replication], uses low-downtime updates, or will use [RDS Blue/Green deployments][blue-green].

BackupTarget string

Specifies where automated backups and manual snapshots are stored. Possible values are region (default) and outposts. See Working with Amazon RDS on AWS Outposts for more information.

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.

Enables low-downtime updates using [RDS Blue/Green deployments][blue-green]. See blue_green_update below

CaCertIdentifier string

The identifier of the CA certificate for the DB instance.

CharacterSetName string

The character set name to use for DB encoding in Oracle and Microsoft SQL instances (collation). This can't be changed. See Oracle Character Sets Supported in Amazon RDS or Server-Level Collation for Microsoft SQL Server for more information.

Copy all Instance tags to snapshots. Default is false.

The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.

Indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. See CoIP for RDS on Outposts for more information.

DbName string

The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Note that this does not apply for Oracle or SQL Server engines. See the AWS documentation for more details on what applies for those engines. If you are providing an Oracle db name, it needs to be in all upper case. Cannot be specified for a replica.

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.

Specifies whether to remove automated backups immediately after the DB instance is deleted. Default is true.

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.

The name of the IAM role to be used when making API calls to the Directory Service.

EnabledCloudwatchLogsExports List<string>

Set of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine). MySQL and MariaDB: audit, error, general, slowquery. PostgreSQL: postgresql, upgrade. MSSQL: agent , error. Oracle: alert, audit, listener, trace.

Engine string

The database engine to use. For supported values, see the Engine parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine must match the DB cluster's engine'. For information on the difference between the available Aurora MySQL engines see Comparison between Aurora MySQL 1 and Aurora MySQL 2 in the Amazon RDS User Guide.

EngineVersion string

The engine version to use. If auto_minor_version_upgrade is enabled, you can provide a prefix of the version such as 5.7 (for 5.7.10). The actual engine version used is returned in the attribute engine_version_actual, see Attribute Reference below. For supported values, see the EngineVersion parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine version must match the DB cluster's engine version'.

The name of your final DB snapshot when this DB instance is deleted. Must be provided if skip_final_snapshot is set to false. The value must begin with a letter, only contain alphanumeric characters and hyphens, and not end with a hyphen or contain two consecutive hyphens. Must not be provided when deleting a read replica.

Specifies whether mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.

Identifier string

The name of the RDS instance, if omitted, this provider will assign a random, unique identifier. Required if restore_to_point_in_time is specified.

IdentifierPrefix string

Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.

Iops int

The amount of provisioned IOPS. Setting this implies a storage_type of "io1". Can only be set when storage_type is "io1" or "gp3". Cannot be specified for gp3 storage if the allocated_storage value is below a per-engine threshold. See the RDS User Guide for details.

KmsKeyId string

The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.

LicenseModel string

(Optional, but required for some DB engines, i.e., Oracle SE1) License model information for this DB instance.

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.

Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if password is provided.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. If not specified, the default KMS key for your Amazon Web Services account is used.

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.

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.

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

Deprecated:

This property has been deprecated. Please use 'dbName' instead.

The national character set is used in the NCHAR, NVARCHAR2, and NCLOB data types for Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS.

NetworkType string

The network type of the DB instance. Valid values: IPV4, DUAL.

OptionGroupName string

Name of the DB option group to associate.

Name of the DB parameter group to associate.

Password string

(Required unless manage_master_user_password is set to true or unless a snapshot_identifier or replicate_source_db is provided or manage_master_user_password is set.) Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Cannot be set if manage_master_user_password is set to true.

Specifies whether Performance Insights are enabled. Defaults to false.

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.

Amount of time in days to retain Performance Insights data. Valid values are 7, 731 (2 years) or a multiple of 31. When specifying performance_insights_retention_period, performance_insights_enabled needs to be set to true. Defaults to '7'.

Port int

The port on which the DB accepts connections.

Bool to control if instance is publicly accessible. Default is false.

ReplicaMode string

Specifies whether the replica is in either mounted or open-read-only mode. This attribute is only supported by Oracle instances. Oracle replicas operate in open-read-only mode unless otherwise specified. See Working with Oracle Read Replicas for more information.

RestoreToPointInTime InstanceRestoreToPointInTime

Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate (if replicating within a single region) or ARN of the Amazon RDS Database to replicate (if replicating cross-region). Note that if you are creating a cross-region replica of an encrypted database you will also need to specify a kms_key_id. See [DB Instance Replication][instance-replication] and Working with PostgreSQL and MySQL Read Replicas for more information on using Replication.

A configuration block for restoring a DB instance to an arbitrary point in time. Requires the identifier argument to be set with the name of the new DB instance to be created. See Restore To Point In Time below for details.

S3Import InstanceS3Import

Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance

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.

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.

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.

The storage throughput value for the DB instance. Can only be set when storage_type is "gp3". Cannot be specified if the allocated_storage value is below a per-engine threshold. See the RDS User Guide for details.

StorageType string | Pulumi.Aws.Rds.StorageType

One of "standard" (magnetic), "gp2" (general purpose SSD), "gp3" (general purpose SSD that needs iops independently) or "io1" (provisioned IOPS SSD). The default is "io1" if iops is specified, "gp2" if not.

Tags Dictionary<string, string>

A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Timezone string

Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information.

Username string

(Required unless a snapshot_identifier or replicate_source_db is provided) Username for the master DB user. Cannot be specified for a replica.

VpcSecurityGroupIds List<string>

List of VPC security groups to associate.

InstanceClass string | InstanceType

The instance type of the RDS instance.

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.

Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.

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.

BlueGreenUpdate InstanceBlueGreenUpdateArgs

BackupTarget string

Specifies where automated backups and manual snapshots are stored. Possible values are region (default) and outposts. See Working with Amazon RDS on AWS Outposts for more information.

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.

Enables low-downtime updates using [RDS Blue/Green deployments][blue-green]. See blue_green_update below

CaCertIdentifier string

The identifier of the CA certificate for the DB instance.

CharacterSetName string

Copy all Instance tags to snapshots. Default is false.

The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.

Indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. See CoIP for RDS on Outposts for more information.

DbName string

Specifies whether to remove automated backups immediately after the DB instance is deleted. Default is true.

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.

The name of the IAM role to be used when making API calls to the Directory Service.

EnabledCloudwatchLogsExports []string

Engine string

EngineVersion string

Specifies whether mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.

Identifier string

The name of the RDS instance, if omitted, this provider will assign a random, unique identifier. Required if restore_to_point_in_time is specified.

IdentifierPrefix string

Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.

Iops int

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.

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.

Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if password is provided.

MultiAz bool

Specifies if the RDS instance is multi-AZ

Name string

Deprecated:

This property has been deprecated. Please use 'dbName' instead.

The national character set is used in the NCHAR, NVARCHAR2, and NCLOB data types for Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS.

NetworkType string

The network type of the DB instance. Valid values: IPV4, DUAL.

OptionGroupName string

Name of the DB option group to associate.

Name of the DB parameter group to associate.

Password string

Specifies whether Performance Insights are enabled. Defaults to false.

Port int

The port on which the DB accepts connections.

Bool to control if instance is publicly accessible. Default is false.

ReplicaMode string

RestoreToPointInTime InstanceRestoreToPointInTimeArgs

S3Import InstanceS3ImportArgs

Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance

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.

StorageType string | StorageType

Tags map[string]string

A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Timezone string

Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information.

Username string

(Required unless a snapshot_identifier or replicate_source_db is provided) Username for the master DB user. Cannot be specified for a replica.

VpcSecurityGroupIds []string

List of VPC security groups to associate.

instanceClass String | InstanceType

The instance type of the RDS instance.

allocatedStorage Integer

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.

Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaults to true.

availabilityZone String

The AZ for the RDS instance.

backupRetentionPeriod Integer

backupTarget String

Specifies where automated backups and manual snapshots are stored. Possible values are region (default) and outposts. See Working with Amazon RDS on AWS Outposts for more information.

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.

Enables low-downtime updates using [RDS Blue/Green deployments][blue-green]. See blue_green_update below

caCertIdentifier String

The identifier of the CA certificate for the DB instance.

characterSetName String

copyTagsToSnapshot Boolean

Copy all Instance tags to snapshots. Default is false.

The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.

Indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. See CoIP for RDS on Outposts for more information.

dbName String

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.

The name of the IAM role to be used when making API calls to the Directory Service.

enabledCloudwatchLogsExports List<String>

engine String

engineVersion String

Specifies whether mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.

identifier String

The name of the RDS instance, if omitted, this provider will assign a random, unique identifier. Required if restore_to_point_in_time is specified.

identifierPrefix String

Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.

iops Integer

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.

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.

Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if password is provided.

maxAllocatedStorage Integer

monitoringInterval Integer

multiAz Boolean

Specifies if the RDS instance is multi-AZ

name String

Deprecated:

This property has been deprecated. Please use 'dbName' instead.

The national character set is used in the NCHAR, NVARCHAR2, and NCLOB data types for Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS.

networkType String

The network type of the DB instance. Valid values: IPV4, DUAL.

optionGroupName String

Name of the DB option group to associate.

Name of the DB parameter group to associate.

password String

Specifies whether Performance Insights are enabled. Defaults to false.

performanceInsightsRetentionPeriod Integer

port Integer

The port on which the DB accepts connections.

publiclyAccessible Boolean

Bool to control if instance is publicly accessible. Default is false.

replicaMode String

restoreToPointInTime InstanceRestoreToPointInTime

Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance

skipFinalSnapshot Boolean

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

storageThroughput Integer

storageType String | StorageType

tags Map<String,String>

A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

timezone String

Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information.

username String

(Required unless a snapshot_identifier or replicate_source_db is provided) Username for the master DB user. Cannot be specified for a replica.

vpcSecurityGroupIds List<String>

List of VPC security groups to associate.

instanceClass string | InstanceType

The instance type of the RDS instance.

allocatedStorage number

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

backupTarget string

Specifies where automated backups and manual snapshots are stored. Possible values are region (default) and outposts. See Working with Amazon RDS on AWS Outposts for more information.

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.

restoreToPointInTime InstanceRestoreToPointInTime

Enables low-downtime updates using [RDS Blue/Green deployments][blue-green]. See blue_green_update below

caCertIdentifier string

The identifier of the CA certificate for the DB instance.

characterSetName string

copyTagsToSnapshot boolean

Copy all Instance tags to snapshots. Default is false.

customIamInstanceProfile string

The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.

customerOwnedIpEnabled boolean

Indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. See CoIP for RDS on Outposts for more information.

dbName string

dbSubnetGroupName string

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[]

engine string

engineVersion string

finalSnapshotIdentifier string

iamDatabaseAuthenticationEnabled boolean

Specifies whether mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.

identifier string

The name of the RDS instance, if omitted, this provider will assign a random, unique identifier. Required if restore_to_point_in_time is specified.

identifierPrefix string

Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.

iops number

kmsKeyId string

The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.

licenseModel string

(Optional, but required for some DB engines, i.e., Oracle SE1) License model information for this DB instance.

maintenanceWindow string

The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00". See RDS Maintenance Window docs for more information.

manageMasterUserPassword boolean

Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if password is provided.

masterUserSecretKmsKeyId string

maxAllocatedStorage number

monitoringInterval number

monitoringRoleArn string

multiAz boolean

Specifies if the RDS instance is multi-AZ

name string

Deprecated:

This property has been deprecated. Please use 'dbName' instead.

ncharCharacterSetName string

The national character set is used in the NCHAR, NVARCHAR2, and NCLOB data types for Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS.

networkType string

The network type of the DB instance. Valid values: IPV4, DUAL.

optionGroupName string

Name of the DB option group to associate.

parameterGroupName string

Name of the DB parameter group to associate.

password string

performanceInsightsEnabled boolean

Specifies whether Performance Insights are enabled. Defaults to false.

performanceInsightsKmsKeyId string

performanceInsightsRetentionPeriod number

port number

The port on which the DB accepts connections.

publiclyAccessible boolean

Bool to control if instance is publicly accessible. Default is false.

replicaMode string

replicateSourceDb string

blue_green_update InstanceBlueGreenUpdateArgs

Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance

skipFinalSnapshot boolean

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

storageThroughput number

storageType string | StorageType

tags {[key: string]: string}

A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

timezone string

Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information.

username string

(Required unless a snapshot_identifier or replicate_source_db is provided) Username for the master DB user. Cannot be specified for a replica.

vpcSecurityGroupIds string[]

List of VPC security groups to associate.

instance_class str | InstanceType

The instance type of the RDS instance.

allocated_storage int

allow_major_version_upgrade bool

Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

apply_immediately bool

Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.

auto_minor_version_upgrade bool

Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaults to true.

availability_zone str

The AZ for the RDS instance.

backup_retention_period int

backup_target str

Specifies where automated backups and manual snapshots are stored. Possible values are region (default) and outposts. See Working with Amazon RDS on AWS Outposts for more information.

backup_window str

The daily time range (in UTC) during which automated backups are created if they are enabled. Example: "09:46-10:16". Must not overlap with maintenance_window.

Enables low-downtime updates using [RDS Blue/Green deployments][blue-green]. See blue_green_update below

ca_cert_identifier str

The identifier of the CA certificate for the DB instance.

character_set_name str

copy_tags_to_snapshot bool

Copy all Instance tags to snapshots. Default is false.

custom_iam_instance_profile str

The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.

customer_owned_ip_enabled bool

Indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. See CoIP for RDS on Outposts for more information.

db_name str

db_subnet_group_name str

delete_automated_backups bool

Specifies whether to remove automated backups immediately after the DB instance is deleted. Default is true.

deletion_protection bool

If the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.

domain str

The ID of the Directory Service Active Directory domain to create the instance in.

domain_iam_role_name str

The name of the IAM role to be used when making API calls to the Directory Service.

enabled_cloudwatch_logs_exports Sequence[str]

engine str

engine_version str

final_snapshot_identifier str

iam_database_authentication_enabled bool

Specifies whether mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.

identifier str

The name of the RDS instance, if omitted, this provider will assign a random, unique identifier. Required if restore_to_point_in_time is specified.

identifier_prefix str

Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.

iops int

kms_key_id str

The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.

license_model str

(Optional, but required for some DB engines, i.e., Oracle SE1) License model information for this DB instance.

maintenance_window str

The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00". See RDS Maintenance Window docs for more information.

manage_master_user_password bool

Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if password is provided.

master_user_secret_kms_key_id str

max_allocated_storage int

monitoring_interval int

monitoring_role_arn str

multi_az bool

Specifies if the RDS instance is multi-AZ

name str

Deprecated:

This property has been deprecated. Please use 'dbName' instead.

nchar_character_set_name str

The national character set is used in the NCHAR, NVARCHAR2, and NCLOB data types for Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS.

network_type str

The network type of the DB instance. Valid values: IPV4, DUAL.

option_group_name str

Name of the DB option group to associate.

parameter_group_name str

Name of the DB parameter group to associate.

password str

performance_insights_enabled bool

Specifies whether Performance Insights are enabled. Defaults to false.

performance_insights_kms_key_id str

performance_insights_retention_period int

port int

The port on which the DB accepts connections.

publicly_accessible bool

Bool to control if instance is publicly accessible. Default is false.

replica_mode str

replicate_source_db str

restore_to_point_in_time InstanceRestoreToPointInTimeArgs

s3_import InstanceS3ImportArgs

Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance

skip_final_snapshot bool

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

storage_throughput int

storage_type str | StorageType

tags Mapping[str, str]

A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

timezone str

Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information.

username str

(Required unless a snapshot_identifier or replicate_source_db is provided) Username for the master DB user. Cannot be specified for a replica.

vpc_security_group_ids Sequence[str]

List of VPC security groups to associate.

The instance type of the RDS instance.

allocatedStorage Number

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.

blueGreenUpdate Property Map

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

backupTarget String

Specifies where automated backups and manual snapshots are stored. Possible values are region (default) and outposts. See Working with Amazon RDS on AWS Outposts for more information.

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.

Enables low-downtime updates using [RDS Blue/Green deployments][blue-green]. See blue_green_update below

caCertIdentifier String

The identifier of the CA certificate for the DB instance.

characterSetName String

copyTagsToSnapshot Boolean

Copy all Instance tags to snapshots. Default is false.

The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.

Indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. See CoIP for RDS on Outposts for more information.

dbName String

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.

The name of the IAM role to be used when making API calls to the Directory Service.

enabledCloudwatchLogsExports List<String>

engine String

engineVersion String

Specifies whether mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.

identifier String

The name of the RDS instance, if omitted, this provider will assign a random, unique identifier. Required if restore_to_point_in_time is specified.

identifierPrefix String

Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.

iops Number

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.

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.

Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if password is provided.

maxAllocatedStorage Number

monitoringInterval Number

multiAz Boolean

Specifies if the RDS instance is multi-AZ

name String

Deprecated:

This property has been deprecated. Please use 'dbName' instead.

The national character set is used in the NCHAR, NVARCHAR2, and NCLOB data types for Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS.

networkType String

The network type of the DB instance. Valid values: IPV4, DUAL.

optionGroupName String

Name of the DB option group to associate.

Name of the DB parameter group to associate.

password String

Specifies whether Performance Insights are enabled. Defaults to false.

performanceInsightsRetentionPeriod Number

port Number

The port on which the DB accepts connections.

publiclyAccessible Boolean

Bool to control if instance is publicly accessible. Default is false.

replicaMode String

restoreToPointInTime Property Map

s3Import Property Map

Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance

skipFinalSnapshot Boolean

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

storageThroughput Number

storageType String | "standard" | "gp2" | "gp3" | "io1"

tags Map<String>

A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

timezone String

Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information.

username String

(Required unless a snapshot_identifier or replicate_source_db is provided) Username for the master DB user. Cannot be specified for a replica.

vpcSecurityGroupIds List<String>

List of VPC security groups to associate.

Outputs

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

Address string

Specifies the DNS address of the DB instance.

Arn string

The ARN of the RDS instance.

Endpoint string

The connection endpoint in address:port format.

The running version of the database.

HostedZoneId string

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

Id string

The provider-assigned unique ID for this managed resource.

ListenerEndpoints List<InstanceListenerEndpoint>

The latest time, in UTC RFC3339 format, to which a database can be restored with point-in-time restore.

Specifies the listener connection endpoint for SQL Server Always On. See endpoint below.

MasterUserSecrets List<InstanceMasterUserSecret>

A block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.

Replicas List<string>

ResourceId string

The RDS Resource ID of this instance.

Status string

The RDS instance status.

TagsAll Dictionary<string, string>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated:

Please use tags instead.

Address string

Specifies the DNS address of the DB instance.

Arn string

The ARN of the RDS instance.

Endpoint string

The connection endpoint in address:port format.

The running version of the database.

HostedZoneId string

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

Id string

The provider-assigned unique ID for this managed resource.

ListenerEndpoints []InstanceListenerEndpoint

The latest time, in UTC RFC3339 format, to which a database can be restored with point-in-time restore.

Specifies the listener connection endpoint for SQL Server Always On. See endpoint below.

MasterUserSecrets []InstanceMasterUserSecret

A block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.

Replicas []string

ResourceId string

The RDS Resource ID of this instance.

Status string

The RDS instance status.

TagsAll map[string]string

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated:

Please use tags instead.

address String

Specifies the DNS address of the DB instance.

arn String

The ARN of the RDS instance.

endpoint String

The connection endpoint in address:port format.

The running version of the database.

hostedZoneId String

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

id String

The provider-assigned unique ID for this managed resource.

listenerEndpoints List<InstanceListenerEndpoint>

The latest time, in UTC RFC3339 format, to which a database can be restored with point-in-time restore.

Specifies the listener connection endpoint for SQL Server Always On. See endpoint below.

masterUserSecrets List<InstanceMasterUserSecret>

A block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.

replicas List<String>

resourceId String

The RDS Resource ID of this instance.

status String

The RDS instance status.

tagsAll Map<String,String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated:

Please use tags instead.

address string

Specifies the DNS address of the DB instance.

arn string

The ARN of the RDS instance.

endpoint string

The connection endpoint in address:port format.

engineVersionActual string

The running version of the database.

hostedZoneId string

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

id string

The provider-assigned unique ID for this managed resource.

latestRestorableTime string

The latest time, in UTC RFC3339 format, to which a database can be restored with point-in-time restore.

listenerEndpoints InstanceListenerEndpoint[]

Specifies the listener connection endpoint for SQL Server Always On. See endpoint below.

masterUserSecrets InstanceMasterUserSecret[]

A block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.

replicas string[]

resourceId string

The RDS Resource ID of this instance.

status string

The RDS instance status.

tagsAll {[key: string]: string}

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated:

Please use tags instead.

address str

Specifies the DNS address of the DB instance.

arn str

The ARN of the RDS instance.

endpoint str

The connection endpoint in address:port format.

engine_version_actual str

The running version of the database.

hosted_zone_id str

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

id str

The provider-assigned unique ID for this managed resource.

latest_restorable_time str

The latest time, in UTC RFC3339 format, to which a database can be restored with point-in-time restore.

listener_endpoints Sequence[InstanceListenerEndpoint]

Specifies the listener connection endpoint for SQL Server Always On. See endpoint below.

master_user_secrets Sequence[InstanceMasterUserSecret]

A block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.

replicas Sequence[str]

resource_id str

The RDS Resource ID of this instance.

status str

The RDS instance status.

tags_all Mapping[str, str]

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated:

Please use tags instead.

address String

Specifies the DNS address of the DB instance.

arn String

The ARN of the RDS instance.

endpoint String

The connection endpoint in address:port format.

The running version of the database.

hostedZoneId String

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

id String

The provider-assigned unique ID for this managed resource.

listenerEndpoints List<Property Map>

The latest time, in UTC RFC3339 format, to which a database can be restored with point-in-time restore.

Specifies the listener connection endpoint for SQL Server Always On. See endpoint below.

masterUserSecrets List<Property Map>

A block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.

replicas List<String>

resourceId String

The RDS Resource ID of this instance.

status String

The RDS instance status.

tagsAll Map<String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated:

Please use tags instead.

Look up Existing Instance Resource

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

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

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

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

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

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

Resource lookup is not supported in YAML

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

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

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

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

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

The following state arguments are supported:

Address string

Specifies the DNS address of the DB instance.

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.

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.

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.

BlueGreenUpdate InstanceBlueGreenUpdate

BackupTarget string

Specifies where automated backups and manual snapshots are stored. Possible values are region (default) and outposts. See Working with Amazon RDS on AWS Outposts for more information.

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.

Enables low-downtime updates using [RDS Blue/Green deployments][blue-green]. See blue_green_update below

CaCertIdentifier string

The identifier of the CA certificate for the DB instance.

CharacterSetName string

Copy all Instance tags to snapshots. Default is false.

The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.

Indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. See CoIP for RDS on Outposts for more information.

DbName string

Specifies whether to remove automated backups immediately after the DB instance is deleted. Default is true.

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.

The name of the IAM role to be used when making API calls to the Directory Service.

EnabledCloudwatchLogsExports List<string>

Endpoint string

The connection endpoint in address:port format.

Engine string

EngineVersion string

The running version of the database.

HostedZoneId string

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

Specifies whether mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.

Identifier string

The name of the RDS instance, if omitted, this provider will assign a random, unique identifier. Required if restore_to_point_in_time is specified.

IdentifierPrefix string

Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.

InstanceClass string | Pulumi.Aws.Rds.InstanceType

The instance type of the RDS instance.

Iops int

KmsKeyId string

The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.

ListenerEndpoints List<InstanceListenerEndpoint>

The latest time, in UTC RFC3339 format, to which a database can be restored with point-in-time restore.

LicenseModel string

(Optional, but required for some DB engines, i.e., Oracle SE1) License model information for this DB instance.

Specifies the listener connection endpoint for SQL Server Always On. See endpoint below.

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.

Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if password is provided.

MasterUserSecrets List<InstanceMasterUserSecret>

A block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.

MultiAz bool

Specifies if the RDS instance is multi-AZ

Name string

Deprecated:

This property has been deprecated. Please use 'dbName' instead.

The national character set is used in the NCHAR, NVARCHAR2, and NCLOB data types for Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS.

NetworkType string

The network type of the DB instance. Valid values: IPV4, DUAL.

OptionGroupName string

Name of the DB option group to associate.

Name of the DB parameter group to associate.

Password string

Specifies whether Performance Insights are enabled. Defaults to false.

Port int

The port on which the DB accepts connections.

Bool to control if instance is publicly accessible. Default is false.

ReplicaMode string

Replicas List<string>

RestoreToPointInTime InstanceRestoreToPointInTime

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

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.

StorageType string | Pulumi.Aws.Rds.StorageType

Tags Dictionary<string, string>

A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TagsAll Dictionary<string, string>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated:

Please use tags instead.

Timezone string

Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information.

Username string

(Required unless a snapshot_identifier or replicate_source_db is provided) Username for the master DB user. Cannot be specified for a replica.

VpcSecurityGroupIds List<string>

List of VPC security groups to associate.

Address string

Specifies the DNS address of the DB instance.

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.

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.

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.

BlueGreenUpdate InstanceBlueGreenUpdateArgs

BackupTarget string

Specifies where automated backups and manual snapshots are stored. Possible values are region (default) and outposts. See Working with Amazon RDS on AWS Outposts for more information.

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.

Enables low-downtime updates using [RDS Blue/Green deployments][blue-green]. See blue_green_update below

CaCertIdentifier string

The identifier of the CA certificate for the DB instance.

CharacterSetName string

Copy all Instance tags to snapshots. Default is false.

The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.

Indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. See CoIP for RDS on Outposts for more information.

DbName string

Specifies whether to remove automated backups immediately after the DB instance is deleted. Default is true.

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.

The name of the IAM role to be used when making API calls to the Directory Service.

EnabledCloudwatchLogsExports []string

Endpoint string

The connection endpoint in address:port format.

Engine string

EngineVersion string

The running version of the database.

HostedZoneId string

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

Specifies whether mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.

Identifier string

The name of the RDS instance, if omitted, this provider will assign a random, unique identifier. Required if restore_to_point_in_time is specified.

IdentifierPrefix string

Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.

InstanceClass string | InstanceType

The instance type of the RDS instance.

Iops int

KmsKeyId string

The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.

ListenerEndpoints []InstanceListenerEndpointArgs

The latest time, in UTC RFC3339 format, to which a database can be restored with point-in-time restore.

LicenseModel string

(Optional, but required for some DB engines, i.e., Oracle SE1) License model information for this DB instance.

Specifies the listener connection endpoint for SQL Server Always On. See endpoint below.

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.

Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if password is provided.

MasterUserSecrets []InstanceMasterUserSecretArgs

A block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.

MultiAz bool

Specifies if the RDS instance is multi-AZ

Name string

Deprecated:

This property has been deprecated. Please use 'dbName' instead.

The national character set is used in the NCHAR, NVARCHAR2, and NCLOB data types for Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS.

NetworkType string

The network type of the DB instance. Valid values: IPV4, DUAL.

OptionGroupName string

Name of the DB option group to associate.

Name of the DB parameter group to associate.

Password string

Specifies whether Performance Insights are enabled. Defaults to false.

Port int

The port on which the DB accepts connections.

Bool to control if instance is publicly accessible. Default is false.

ReplicaMode string

Replicas []string

RestoreToPointInTime InstanceRestoreToPointInTimeArgs

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

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.

StorageType string | StorageType

Tags map[string]string

A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TagsAll map[string]string

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated:

Please use tags instead.

Timezone string

Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information.

Username string

(Required unless a snapshot_identifier or replicate_source_db is provided) Username for the master DB user. Cannot be specified for a replica.

VpcSecurityGroupIds []string

List of VPC security groups to associate.

address String

Specifies the DNS address of the DB instance.

allocatedStorage Integer

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.

Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaults to true.

availabilityZone String

The AZ for the RDS instance.

backupRetentionPeriod Integer

backupTarget String

Specifies where automated backups and manual snapshots are stored. Possible values are region (default) and outposts. See Working with Amazon RDS on AWS Outposts for more information.

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.

Enables low-downtime updates using [RDS Blue/Green deployments][blue-green]. See blue_green_update below

caCertIdentifier String

The identifier of the CA certificate for the DB instance.

characterSetName String

copyTagsToSnapshot Boolean

Copy all Instance tags to snapshots. Default is false.

The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.

Indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. See CoIP for RDS on Outposts for more information.

dbName String

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.

The name of the IAM role to be used when making API calls to the Directory Service.

enabledCloudwatchLogsExports List<String>

endpoint String

The connection endpoint in address:port format.

engine String

engineVersion String

The running version of the database.

hostedZoneId String

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

Specifies whether mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.

identifier String

The name of the RDS instance, if omitted, this provider will assign a random, unique identifier. Required if restore_to_point_in_time is specified.

identifierPrefix String

Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.

instanceClass String | InstanceType

The instance type of the RDS instance.

iops Integer

kmsKeyId String

The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.

listenerEndpoints List<InstanceListenerEndpoint>

The latest time, in UTC RFC3339 format, to which a database can be restored with point-in-time restore.

licenseModel String

(Optional, but required for some DB engines, i.e., Oracle SE1) License model information for this DB instance.

Specifies the listener connection endpoint for SQL Server Always On. See endpoint below.

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.

Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if password is provided.

masterUserSecrets List<InstanceMasterUserSecret>

A block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.

maxAllocatedStorage Integer

monitoringInterval Integer

multiAz Boolean

Specifies if the RDS instance is multi-AZ

name String

Deprecated:

This property has been deprecated. Please use 'dbName' instead.

The national character set is used in the NCHAR, NVARCHAR2, and NCLOB data types for Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS.

networkType String

The network type of the DB instance. Valid values: IPV4, DUAL.

optionGroupName String

Name of the DB option group to associate.

Name of the DB parameter group to associate.

password String

Specifies whether Performance Insights are enabled. Defaults to false.

performanceInsightsRetentionPeriod Integer

port Integer

The port on which the DB accepts connections.

publiclyAccessible Boolean

Bool to control if instance is publicly accessible. Default is false.

replicaMode String

replicas List<String>

restoreToPointInTime InstanceRestoreToPointInTime

resourceId String

The RDS Resource ID of this instance.

Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance

skipFinalSnapshot Boolean

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

storageThroughput Integer

storageType String | StorageType

tags Map<String,String>

A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll Map<String,String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated:

Please use tags instead.

timezone String

Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information.

username String

(Required unless a snapshot_identifier or replicate_source_db is provided) Username for the master DB user. Cannot be specified for a replica.

vpcSecurityGroupIds List<String>

List of VPC security groups to associate.

address string

Specifies the DNS address of the DB instance.

allocatedStorage number

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

backupTarget string

Specifies where automated backups and manual snapshots are stored. Possible values are region (default) and outposts. See Working with Amazon RDS on AWS Outposts for more information.

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.

listenerEndpoints InstanceListenerEndpoint[]

Enables low-downtime updates using [RDS Blue/Green deployments][blue-green]. See blue_green_update below

caCertIdentifier string

The identifier of the CA certificate for the DB instance.

characterSetName string

copyTagsToSnapshot boolean

Copy all Instance tags to snapshots. Default is false.

customIamInstanceProfile string

The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.

customerOwnedIpEnabled boolean

Indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. See CoIP for RDS on Outposts for more information.

dbName string

dbSubnetGroupName string

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[]

endpoint string

The connection endpoint in address:port format.

engine string

engineVersion string

engineVersionActual string

The running version of the database.

finalSnapshotIdentifier string

hostedZoneId string

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

iamDatabaseAuthenticationEnabled boolean

Specifies whether mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.

identifier string

The name of the RDS instance, if omitted, this provider will assign a random, unique identifier. Required if restore_to_point_in_time is specified.

identifierPrefix string

Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.

instanceClass string | InstanceType

The instance type of the RDS instance.

iops number

kmsKeyId string

The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.

latestRestorableTime string

The latest time, in UTC RFC3339 format, to which a database can be restored with point-in-time restore.

licenseModel string

(Optional, but required for some DB engines, i.e., Oracle SE1) License model information for this DB instance.

Specifies the listener connection endpoint for SQL Server Always On. See endpoint below.

maintenanceWindow string

The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00". See RDS Maintenance Window docs for more information.

manageMasterUserPassword boolean

Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if password is provided.

masterUserSecretKmsKeyId string

masterUserSecrets InstanceMasterUserSecret[]

A block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.

maxAllocatedStorage number

monitoringInterval number

monitoringRoleArn string

multiAz boolean

Specifies if the RDS instance is multi-AZ

name string

Deprecated:

This property has been deprecated. Please use 'dbName' instead.

ncharCharacterSetName string

The national character set is used in the NCHAR, NVARCHAR2, and NCLOB data types for Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS.

networkType string

The network type of the DB instance. Valid values: IPV4, DUAL.

optionGroupName string

Name of the DB option group to associate.

parameterGroupName string

Name of the DB parameter group to associate.

password string

performanceInsightsEnabled boolean

Specifies whether Performance Insights are enabled. Defaults to false.

performanceInsightsKmsKeyId string

performanceInsightsRetentionPeriod number

port number

The port on which the DB accepts connections.

publiclyAccessible boolean

Bool to control if instance is publicly accessible. Default is false.

replicaMode string

replicas string[]

replicateSourceDb string

resourceId string

The RDS Resource ID of this instance.

restoreToPointInTime InstanceRestoreToPointInTime

blue_green_update InstanceBlueGreenUpdateArgs

Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance

skipFinalSnapshot boolean

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

storageThroughput number

storageType string | StorageType

tags {[key: string]: string}

A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll {[key: string]: string}

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated:

Please use tags instead.

timezone string

Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information.

username string

(Required unless a snapshot_identifier or replicate_source_db is provided) Username for the master DB user. Cannot be specified for a replica.

vpcSecurityGroupIds string[]

List of VPC security groups to associate.

address str

Specifies the DNS address of the DB instance.

allocated_storage int

allow_major_version_upgrade bool

Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

apply_immediately bool

Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.

arn str

The ARN of the RDS instance.

auto_minor_version_upgrade bool

Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaults to true.

availability_zone str

The AZ for the RDS instance.

backup_retention_period int

backup_target str

Specifies where automated backups and manual snapshots are stored. Possible values are region (default) and outposts. See Working with Amazon RDS on AWS Outposts for more information.

backup_window str

The daily time range (in UTC) during which automated backups are created if they are enabled. Example: "09:46-10:16". Must not overlap with maintenance_window.

Enables low-downtime updates using [RDS Blue/Green deployments][blue-green]. See blue_green_update below

ca_cert_identifier str

The identifier of the CA certificate for the DB instance.

character_set_name str

copy_tags_to_snapshot bool

Copy all Instance tags to snapshots. Default is false.

custom_iam_instance_profile str

The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.

customer_owned_ip_enabled bool

Indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. See CoIP for RDS on Outposts for more information.

db_name str

db_subnet_group_name str

delete_automated_backups bool

Specifies whether to remove automated backups immediately after the DB instance is deleted. Default is true.

deletion_protection bool

If the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.

domain str

The ID of the Directory Service Active Directory domain to create the instance in.

domain_iam_role_name str

The name of the IAM role to be used when making API calls to the Directory Service.

enabled_cloudwatch_logs_exports Sequence[str]

endpoint str

The connection endpoint in address:port format.

engine str

engine_version str

engine_version_actual str

The running version of the database.

final_snapshot_identifier str

hosted_zone_id str

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

iam_database_authentication_enabled bool

Specifies whether mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.

identifier str

The name of the RDS instance, if omitted, this provider will assign a random, unique identifier. Required if restore_to_point_in_time is specified.

identifier_prefix str

Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.

instance_class str | InstanceType

The instance type of the RDS instance.

iops int

kms_key_id str

The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.

latest_restorable_time str

The latest time, in UTC RFC3339 format, to which a database can be restored with point-in-time restore.

license_model str

(Optional, but required for some DB engines, i.e., Oracle SE1) License model information for this DB instance.

listener_endpoints Sequence[InstanceListenerEndpointArgs]

Specifies the listener connection endpoint for SQL Server Always On. See endpoint below.

maintenance_window str

The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00". See RDS Maintenance Window docs for more information.

manage_master_user_password bool

Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if password is provided.

master_user_secret_kms_key_id str

master_user_secrets Sequence[InstanceMasterUserSecretArgs]

A block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.

max_allocated_storage int

monitoring_interval int

monitoring_role_arn str

multi_az bool

Specifies if the RDS instance is multi-AZ

name str

Deprecated:

This property has been deprecated. Please use 'dbName' instead.

nchar_character_set_name str

The national character set is used in the NCHAR, NVARCHAR2, and NCLOB data types for Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS.

network_type str

The network type of the DB instance. Valid values: IPV4, DUAL.

option_group_name str

Name of the DB option group to associate.

parameter_group_name str

Name of the DB parameter group to associate.

password str

performance_insights_enabled bool

Specifies whether Performance Insights are enabled. Defaults to false.

performance_insights_kms_key_id str

performance_insights_retention_period int

port int

The port on which the DB accepts connections.

publicly_accessible bool

Bool to control if instance is publicly accessible. Default is false.

replica_mode str

replicas Sequence[str]

replicate_source_db str

resource_id str

The RDS Resource ID of this instance.

restore_to_point_in_time InstanceRestoreToPointInTimeArgs

s3_import InstanceS3ImportArgs

Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance

skip_final_snapshot bool

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

storage_throughput int

storage_type str | StorageType

tags Mapping[str, str]

A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tags_all Mapping[str, str]

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated:

Please use tags instead.

timezone str

Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information.

username str

(Required unless a snapshot_identifier or replicate_source_db is provided) Username for the master DB user. Cannot be specified for a replica.

vpc_security_group_ids Sequence[str]

List of VPC security groups to associate.

address String

Specifies the DNS address of the DB instance.

allocatedStorage Number

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.

blueGreenUpdate Property Map

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

backupTarget String

Specifies where automated backups and manual snapshots are stored. Possible values are region (default) and outposts. See Working with Amazon RDS on AWS Outposts for more information.

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.

Enables low-downtime updates using [RDS Blue/Green deployments][blue-green]. See blue_green_update below

caCertIdentifier String

The identifier of the CA certificate for the DB instance.

characterSetName String

copyTagsToSnapshot Boolean

Copy all Instance tags to snapshots. Default is false.

The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.

Indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. See CoIP for RDS on Outposts for more information.

dbName String

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.

The name of the IAM role to be used when making API calls to the Directory Service.

enabledCloudwatchLogsExports List<String>

endpoint String

The connection endpoint in address:port format.

engine String

engineVersion String

The running version of the database.

hostedZoneId String

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

Specifies whether mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.

identifier String

The name of the RDS instance, if omitted, this provider will assign a random, unique identifier. Required if restore_to_point_in_time is specified.

identifierPrefix String

Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.

The instance type of the RDS instance.

iops Number

kmsKeyId String

The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.

listenerEndpoints List<Property Map>

The latest time, in UTC RFC3339 format, to which a database can be restored with point-in-time restore.

licenseModel String

(Optional, but required for some DB engines, i.e., Oracle SE1) License model information for this DB instance.

Specifies the listener connection endpoint for SQL Server Always On. See endpoint below.

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.

Set to true to allow RDS to manage the master user password in Secrets Manager. Cannot be set if password is provided.

masterUserSecrets List<Property Map>

A block that specifies the master user secret. Only available when manage_master_user_password is set to true. Documented below.

maxAllocatedStorage Number

monitoringInterval Number

multiAz Boolean

Specifies if the RDS instance is multi-AZ

name String

Deprecated:

This property has been deprecated. Please use 'dbName' instead.

The national character set is used in the NCHAR, NVARCHAR2, and NCLOB data types for Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS.

networkType String

The network type of the DB instance. Valid values: IPV4, DUAL.

optionGroupName String

Name of the DB option group to associate.

Name of the DB parameter group to associate.

password String

Specifies whether Performance Insights are enabled. Defaults to false.

performanceInsightsRetentionPeriod Number

port Number

The port on which the DB accepts connections.

publiclyAccessible Boolean

Bool to control if instance is publicly accessible. Default is false.

replicaMode String

replicas List<String>

restoreToPointInTime Property Map

resourceId String

The RDS Resource ID of this instance.

s3Import Property Map

Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance

skipFinalSnapshot Boolean