aws.rds.ClusterInstance
Explore with Pulumi AI
Provides an RDS Cluster Instance Resource. A Cluster Instance Resource defines attributes that are specific to a single instance in a RDS Cluster, specifically running Amazon Aurora.
Unlike other RDS resources that support replication, with Amazon Aurora you do
not designate a primary and subsequent replicas. Instead, you simply add RDS
Instances and Aurora manages the replication. You can use the [count][5]
meta-parameter to make multiple instances and join them all to the same RDS
Cluster, or you may specify different Cluster Instance resources with various
instance_class
sizes.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
NOTE: Deletion Protection from the RDS service can only be enabled at the cluster level, not for individual cluster instances. You can still add the
protect
CustomResourceOption to this resource configuration if you desire protection from accidental deletion.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var @default = new Aws.Rds.Cluster("default", new()
{
ClusterIdentifier = "aurora-cluster-demo",
AvailabilityZones = new[]
{
"us-west-2a",
"us-west-2b",
"us-west-2c",
},
DatabaseName = "mydb",
MasterUsername = "foo",
MasterPassword = "barbut8chars",
});
var clusterInstances = new List<Aws.Rds.ClusterInstance>();
for (var rangeIndex = 0; rangeIndex < 2; rangeIndex++)
{
var range = new { Value = rangeIndex };
clusterInstances.Add(new Aws.Rds.ClusterInstance($"clusterInstances-{range.Value}", new()
{
Identifier = $"aurora-cluster-demo-{range.Value}",
ClusterIdentifier = @default.Id,
InstanceClass = "db.r4.large",
Engine = @default.Engine,
EngineVersion = @default.EngineVersion,
}));
}
});
package main
import (
"fmt"
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/rds"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := rds.NewCluster(ctx, "default", &rds.ClusterArgs{
ClusterIdentifier: pulumi.String("aurora-cluster-demo"),
AvailabilityZones: pulumi.StringArray{
pulumi.String("us-west-2a"),
pulumi.String("us-west-2b"),
pulumi.String("us-west-2c"),
},
DatabaseName: pulumi.String("mydb"),
MasterUsername: pulumi.String("foo"),
MasterPassword: pulumi.String("barbut8chars"),
})
if err != nil {
return err
}
var clusterInstances []*rds.ClusterInstance
for index := 0; index < 2; index++ {
key0 := index
val0 := index
__res, err := rds.NewClusterInstance(ctx, fmt.Sprintf("clusterInstances-%v", key0), &rds.ClusterInstanceArgs{
Identifier: pulumi.String(fmt.Sprintf("aurora-cluster-demo-%v", val0)),
ClusterIdentifier: _default.ID(),
InstanceClass: pulumi.String("db.r4.large"),
Engine: _default.Engine,
EngineVersion: _default.EngineVersion,
})
if err != nil {
return err
}
clusterInstances = append(clusterInstances, __res)
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.rds.Cluster;
import com.pulumi.aws.rds.ClusterArgs;
import com.pulumi.aws.rds.ClusterInstance;
import com.pulumi.aws.rds.ClusterInstanceArgs;
import com.pulumi.codegen.internal.KeyedValue;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var default_ = new Cluster("default", ClusterArgs.builder()
.clusterIdentifier("aurora-cluster-demo")
.availabilityZones(
"us-west-2a",
"us-west-2b",
"us-west-2c")
.databaseName("mydb")
.masterUsername("foo")
.masterPassword("barbut8chars")
.build());
for (var i = 0; i < 2; i++) {
new ClusterInstance("clusterInstances-" + i, ClusterInstanceArgs.builder()
.identifier(String.format("aurora-cluster-demo-%s", range.value()))
.clusterIdentifier(default_.id())
.instanceClass("db.r4.large")
.engine(default_.engine())
.engineVersion(default_.engineVersion())
.build());
}
}
}
import pulumi
import pulumi_aws as aws
default = aws.rds.Cluster("default",
cluster_identifier="aurora-cluster-demo",
availability_zones=[
"us-west-2a",
"us-west-2b",
"us-west-2c",
],
database_name="mydb",
master_username="foo",
master_password="barbut8chars")
cluster_instances = []
for range in [{"value": i} for i in range(0, 2)]:
cluster_instances.append(aws.rds.ClusterInstance(f"clusterInstances-{range['value']}",
identifier=f"aurora-cluster-demo-{range['value']}",
cluster_identifier=default.id,
instance_class="db.r4.large",
engine=default.engine,
engine_version=default.engine_version))
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const _default = new aws.rds.Cluster("default", {
clusterIdentifier: "aurora-cluster-demo",
availabilityZones: [
"us-west-2a",
"us-west-2b",
"us-west-2c",
],
databaseName: "mydb",
masterUsername: "foo",
masterPassword: "barbut8chars",
});
const clusterInstances: aws.rds.ClusterInstance[] = [];
for (const range = {value: 0}; range.value < 2; range.value++) {
clusterInstances.push(new aws.rds.ClusterInstance(`clusterInstances-${range.value}`, {
identifier: `aurora-cluster-demo-${range.value}`,
clusterIdentifier: _default.id,
instanceClass: "db.r4.large",
engine: _default.engine,
engineVersion: _default.engineVersion,
}));
}
resources:
clusterInstances:
type: aws:rds:ClusterInstance
properties:
identifier: aurora-cluster-demo-${range.value}
clusterIdentifier: ${default.id}
instanceClass: db.r4.large
engine: ${default.engine}
engineVersion: ${default.engineVersion}
options: {}
default:
type: aws:rds:Cluster
properties:
clusterIdentifier: aurora-cluster-demo
availabilityZones:
- us-west-2a
- us-west-2b
- us-west-2c
databaseName: mydb
masterUsername: foo
masterPassword: barbut8chars
Create ClusterInstance Resource
new ClusterInstance(name: string, args: ClusterInstanceArgs, opts?: CustomResourceOptions);
@overload
def ClusterInstance(resource_name: str,
opts: Optional[ResourceOptions] = None,
apply_immediately: Optional[bool] = None,
auto_minor_version_upgrade: Optional[bool] = None,
availability_zone: Optional[str] = None,
ca_cert_identifier: Optional[str] = None,
cluster_identifier: Optional[str] = None,
copy_tags_to_snapshot: Optional[bool] = None,
db_parameter_group_name: Optional[str] = None,
db_subnet_group_name: Optional[str] = None,
engine: Optional[str] = None,
engine_version: Optional[str] = None,
identifier: Optional[str] = None,
identifier_prefix: Optional[str] = None,
instance_class: Optional[Union[str, InstanceType]] = None,
monitoring_interval: Optional[int] = None,
monitoring_role_arn: Optional[str] = None,
performance_insights_enabled: Optional[bool] = None,
performance_insights_kms_key_id: Optional[str] = None,
performance_insights_retention_period: Optional[int] = None,
preferred_backup_window: Optional[str] = None,
preferred_maintenance_window: Optional[str] = None,
promotion_tier: Optional[int] = None,
publicly_accessible: Optional[bool] = None,
tags: Optional[Mapping[str, str]] = None)
@overload
def ClusterInstance(resource_name: str,
args: ClusterInstanceArgs,
opts: Optional[ResourceOptions] = None)
func NewClusterInstance(ctx *Context, name string, args ClusterInstanceArgs, opts ...ResourceOption) (*ClusterInstance, error)
public ClusterInstance(string name, ClusterInstanceArgs args, CustomResourceOptions? opts = null)
public ClusterInstance(String name, ClusterInstanceArgs args)
public ClusterInstance(String name, ClusterInstanceArgs args, CustomResourceOptions options)
type: aws:rds:ClusterInstance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ClusterInstanceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ClusterInstanceArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ClusterInstanceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ClusterInstanceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ClusterInstanceArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
ClusterInstance Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The ClusterInstance resource accepts the following input properties:
- Cluster
Identifier string The identifier of the
aws.rds.Cluster
in which to launch this instance.- Instance
Class string | Pulumi.Aws. Rds. Instance Type The instance class to use. For details on CPU and memory, see Scaling Aurora DB Instances. Aurora uses
db.*
instance classes/types. Please see AWS Documentation for currently available instance classes and complete details.- Apply
Immediately bool Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is
false
.- Auto
Minor boolVersion Upgrade Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default
true
.- Availability
Zone string The EC2 Availability Zone that the DB instance is created in. See docs about the details.
- Ca
Cert stringIdentifier The identifier of the CA certificate for the DB instance.
- bool
Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance. Default
false
.- Db
Parameter stringGroup Name The name of the DB parameter group to associate with this instance.
- Db
Subnet stringGroup Name A DB subnet group to associate with this DB instance. NOTE: This must match the
db_subnet_group_name
of the attachedaws.rds.Cluster
.- Engine string
The name of the database engine to be used for the RDS instance. Defaults to
aurora
. Valid Values:aurora
,aurora-mysql
,aurora-postgresql
. For information on the difference between the available Aurora MySQL engines see Comparison between Aurora MySQL 1 and Aurora MySQL 2 in the Amazon RDS User Guide.- Engine
Version string The database engine version.
- Identifier string
The indentifier for the RDS instance, if omitted, this provider will assign a random, unique identifier.
- Identifier
Prefix string Creates a unique identifier beginning with the specified prefix. Conflicts with
identifier
.- Monitoring
Interval int The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
- Monitoring
Role stringArn The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
- Performance
Insights boolEnabled Specifies whether Performance Insights is enabled or not.
- Performance
Insights stringKms Key Id 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.- Performance
Insights intRetention Period Amount of time in days to retain Performance Insights data. Valid values are
7
,731
(2 years) or a multiple of31
. When specifyingperformance_insights_retention_period
,performance_insights_enabled
needs to be set to true. Defaults to '7'.- Preferred
Backup stringWindow The daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00". NOTE: If
preferred_backup_window
is set at the cluster level, this argument must be omitted.- Preferred
Maintenance stringWindow The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
- Promotion
Tier int Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoted to writer.
- Publicly
Accessible bool Bool to control if instance is publicly accessible. Default
false
. See the documentation on Creating DB Instances for more details on controlling this property.- Dictionary<string, string>
A map of tags to assign to the instance. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- Cluster
Identifier string The identifier of the
aws.rds.Cluster
in which to launch this instance.- Instance
Class string | InstanceType The instance class to use. For details on CPU and memory, see Scaling Aurora DB Instances. Aurora uses
db.*
instance classes/types. Please see AWS Documentation for currently available instance classes and complete details.- Apply
Immediately bool Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is
false
.- Auto
Minor boolVersion Upgrade Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default
true
.- Availability
Zone string The EC2 Availability Zone that the DB instance is created in. See docs about the details.
- Ca
Cert stringIdentifier The identifier of the CA certificate for the DB instance.
- bool
Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance. Default
false
.- Db
Parameter stringGroup Name The name of the DB parameter group to associate with this instance.
- Db
Subnet stringGroup Name A DB subnet group to associate with this DB instance. NOTE: This must match the
db_subnet_group_name
of the attachedaws.rds.Cluster
.- Engine string
The name of the database engine to be used for the RDS instance. Defaults to
aurora
. Valid Values:aurora
,aurora-mysql
,aurora-postgresql
. For information on the difference between the available Aurora MySQL engines see Comparison between Aurora MySQL 1 and Aurora MySQL 2 in the Amazon RDS User Guide.- Engine
Version string The database engine version.
- Identifier string
The indentifier for the RDS instance, if omitted, this provider will assign a random, unique identifier.
- Identifier
Prefix string Creates a unique identifier beginning with the specified prefix. Conflicts with
identifier
.- Monitoring
Interval int The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
- Monitoring
Role stringArn The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
- Performance
Insights boolEnabled Specifies whether Performance Insights is enabled or not.
- Performance
Insights stringKms Key Id 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.- Performance
Insights intRetention Period Amount of time in days to retain Performance Insights data. Valid values are
7
,731
(2 years) or a multiple of31
. When specifyingperformance_insights_retention_period
,performance_insights_enabled
needs to be set to true. Defaults to '7'.- Preferred
Backup stringWindow The daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00". NOTE: If
preferred_backup_window
is set at the cluster level, this argument must be omitted.- Preferred
Maintenance stringWindow The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
- Promotion
Tier int Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoted to writer.
- Publicly
Accessible bool Bool to control if instance is publicly accessible. Default
false
. See the documentation on Creating DB Instances for more details on controlling this property.- map[string]string
A map of tags to assign to the instance. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- cluster
Identifier String The identifier of the
aws.rds.Cluster
in which to launch this instance.- instance
Class String | InstanceType The instance class to use. For details on CPU and memory, see Scaling Aurora DB Instances. Aurora uses
db.*
instance classes/types. Please see AWS Documentation for currently available instance classes and complete details.- apply
Immediately Boolean Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is
false
.- auto
Minor BooleanVersion Upgrade Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default
true
.- availability
Zone String The EC2 Availability Zone that the DB instance is created in. See docs about the details.
- ca
Cert StringIdentifier The identifier of the CA certificate for the DB instance.
- Boolean
Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance. Default
false
.- db
Parameter StringGroup Name The name of the DB parameter group to associate with this instance.
- db
Subnet StringGroup Name A DB subnet group to associate with this DB instance. NOTE: This must match the
db_subnet_group_name
of the attachedaws.rds.Cluster
.- engine String
The name of the database engine to be used for the RDS instance. Defaults to
aurora
. Valid Values:aurora
,aurora-mysql
,aurora-postgresql
. For information on the difference between the available Aurora MySQL engines see Comparison between Aurora MySQL 1 and Aurora MySQL 2 in the Amazon RDS User Guide.- engine
Version String The database engine version.
- identifier String
The indentifier for the RDS instance, if omitted, this provider will assign a random, unique identifier.
- identifier
Prefix String Creates a unique identifier beginning with the specified prefix. Conflicts with
identifier
.- monitoring
Interval Integer The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
- monitoring
Role StringArn The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
- performance
Insights BooleanEnabled Specifies whether Performance Insights is enabled or not.
- performance
Insights StringKms Key Id 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.- performance
Insights IntegerRetention Period Amount of time in days to retain Performance Insights data. Valid values are
7
,731
(2 years) or a multiple of31
. When specifyingperformance_insights_retention_period
,performance_insights_enabled
needs to be set to true. Defaults to '7'.- preferred
Backup StringWindow The daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00". NOTE: If
preferred_backup_window
is set at the cluster level, this argument must be omitted.- preferred
Maintenance StringWindow The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
- promotion
Tier Integer Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoted to writer.
- publicly
Accessible Boolean Bool to control if instance is publicly accessible. Default
false
. See the documentation on Creating DB Instances for more details on controlling this property.- Map<String,String>
A map of tags to assign to the instance. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- cluster
Identifier string The identifier of the
aws.rds.Cluster
in which to launch this instance.- instance
Class string | InstanceType The instance class to use. For details on CPU and memory, see Scaling Aurora DB Instances. Aurora uses
db.*
instance classes/types. Please see AWS Documentation for currently available instance classes and complete details.- apply
Immediately boolean Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is
false
.- auto
Minor booleanVersion Upgrade Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default
true
.- availability
Zone string The EC2 Availability Zone that the DB instance is created in. See docs about the details.
- ca
Cert stringIdentifier The identifier of the CA certificate for the DB instance.
- boolean
Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance. Default
false
.- db
Parameter stringGroup Name The name of the DB parameter group to associate with this instance.
- db
Subnet stringGroup Name A DB subnet group to associate with this DB instance. NOTE: This must match the
db_subnet_group_name
of the attachedaws.rds.Cluster
.- engine
Engine
Type The name of the database engine to be used for the RDS instance. Defaults to
aurora
. Valid Values:aurora
,aurora-mysql
,aurora-postgresql
. For information on the difference between the available Aurora MySQL engines see Comparison between Aurora MySQL 1 and Aurora MySQL 2 in the Amazon RDS User Guide.- engine
Version string The database engine version.
- identifier string
The indentifier for the RDS instance, if omitted, this provider will assign a random, unique identifier.
- identifier
Prefix string Creates a unique identifier beginning with the specified prefix. Conflicts with
identifier
.- monitoring
Interval number The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
- monitoring
Role stringArn The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
- performance
Insights booleanEnabled Specifies whether Performance Insights is enabled or not.
- performance
Insights stringKms Key Id 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.- performance
Insights numberRetention Period Amount of time in days to retain Performance Insights data. Valid values are
7
,731
(2 years) or a multiple of31
. When specifyingperformance_insights_retention_period
,performance_insights_enabled
needs to be set to true. Defaults to '7'.- preferred
Backup stringWindow The daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00". NOTE: If
preferred_backup_window
is set at the cluster level, this argument must be omitted.- preferred
Maintenance stringWindow The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
- promotion
Tier number Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoted to writer.
- publicly
Accessible boolean Bool to control if instance is publicly accessible. Default
false
. See the documentation on Creating DB Instances for more details on controlling this property.- {[key: string]: string}
A map of tags to assign to the instance. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- cluster_
identifier str The identifier of the
aws.rds.Cluster
in which to launch this instance.- instance_
class str | InstanceType The instance class to use. For details on CPU and memory, see Scaling Aurora DB Instances. Aurora uses
db.*
instance classes/types. Please see AWS Documentation for currently available instance classes and complete details.- apply_
immediately bool Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is
false
.- auto_
minor_ boolversion_ upgrade Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default
true
.- availability_
zone str The EC2 Availability Zone that the DB instance is created in. See docs about the details.
- ca_
cert_ stridentifier The identifier of the CA certificate for the DB instance.
- bool
Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance. Default
false
.- db_
parameter_ strgroup_ name The name of the DB parameter group to associate with this instance.
- db_
subnet_ strgroup_ name A DB subnet group to associate with this DB instance. NOTE: This must match the
db_subnet_group_name
of the attachedaws.rds.Cluster
.- engine str
The name of the database engine to be used for the RDS instance. Defaults to
aurora
. Valid Values:aurora
,aurora-mysql
,aurora-postgresql
. 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 database engine version.
- identifier str
The indentifier for 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
.- monitoring_
interval int The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
- monitoring_
role_ strarn The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
- performance_
insights_ boolenabled Specifies whether Performance Insights is enabled or not.
- performance_
insights_ strkms_ key_ id 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.- performance_
insights_ intretention_ period Amount of time in days to retain Performance Insights data. Valid values are
7
,731
(2 years) or a multiple of31
. When specifyingperformance_insights_retention_period
,performance_insights_enabled
needs to be set to true. Defaults to '7'.- preferred_
backup_ strwindow The daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00". NOTE: If
preferred_backup_window
is set at the cluster level, this argument must be omitted.- preferred_
maintenance_ strwindow The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
- promotion_
tier int Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoted to writer.
- publicly_
accessible bool Bool to control if instance is publicly accessible. Default
false
. See the documentation on Creating DB Instances for more details on controlling this property.- Mapping[str, str]
A map of tags to assign to the instance. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- cluster
Identifier String The identifier of the
aws.rds.Cluster
in which to launch this instance.- instance
Class String | "db.t4g.micro" | "db.t4g.small" | "db.t4g.medium" | "db.t4g.large" | "db.t4g.xlarge" | "db.t4g.2xlarge" | "db.t3.micro" | "db.t3.small" | "db.t3.medium" | "db.t3.large" | "db.t3.xlarge" | "db.t3.2xlarge" | "db.t2.micro" | "db.t2.small" | "db.t2.medium" | "db.t2.large" | "db.t2.xlarge" | "db.t2.2xlarge" | "db.m1.small" | "db.m1.medium" | "db.m1.large" | "db.m1.xlarge" | "db.m2.xlarge" | "db.m2.2xlarge" | "db.m2.4xlarge" | "db.m3.medium" | "db.m3.large" | "db.m3.xlarge" | "db.m3.2xlarge" | "db.m4.large" | "db.m4.xlarge" | "db.m4.2xlarge" | "db.m4.4xlarge" | "db.m4.10xlarge" | "db.m4.10xlarge" | "db.m5.large" | "db.m5.xlarge" | "db.m5.2xlarge" | "db.m5.4xlarge" | "db.m5.12xlarge" | "db.m5.24xlarge" | "db.m6g.large" | "db.m6g.xlarge" | "db.m6g.2xlarge" | "db.m6g.4xlarge" | "db.m6g.8xlarge" | "db.m6g.12xlarge" | "db.m6g.16xlarge" | "db.r3.large" | "db.r3.xlarge" | "db.r3.2xlarge" | "db.r3.4xlarge" | "db.r3.8xlarge" | "db.r4.large" | "db.r4.xlarge" | "db.r4.2xlarge" | "db.r4.4xlarge" | "db.r4.8xlarge" | "db.r4.16xlarge" | "db.r5.large" | "db.r5.xlarge" | "db.r5.2xlarge" | "db.r5.4xlarge" | "db.r5.12xlarge" | "db.r5.24xlarge" | "db.r6g.large" | "db.r6g.xlarge" | "db.r6g.2xlarge" | "db.r6g.4xlarge" | "db.r6g.8xlarge" | "db.r6g.12xlarge" | "db.r6g.16xlarge" | "db.x1.16xlarge" | "db.x1.32xlarge" | "db.x1e.xlarge" | "db.x1e.2xlarge" | "db.x1e.4xlarge" | "db.x1e.8xlarge" | "db.x1e.32xlarge" The instance class to use. For details on CPU and memory, see Scaling Aurora DB Instances. Aurora uses
db.*
instance classes/types. Please see AWS Documentation for currently available instance classes and complete details.- apply
Immediately Boolean Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is
false
.- auto
Minor BooleanVersion Upgrade Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default
true
.- availability
Zone String The EC2 Availability Zone that the DB instance is created in. See docs about the details.
- ca
Cert StringIdentifier The identifier of the CA certificate for the DB instance.
- Boolean
Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance. Default
false
.- db
Parameter StringGroup Name The name of the DB parameter group to associate with this instance.
- db
Subnet StringGroup Name A DB subnet group to associate with this DB instance. NOTE: This must match the
db_subnet_group_name
of the attachedaws.rds.Cluster
.- engine
The name of the database engine to be used for the RDS instance. Defaults to
aurora
. Valid Values:aurora
,aurora-mysql
,aurora-postgresql
. For information on the difference between the available Aurora MySQL engines see Comparison between Aurora MySQL 1 and Aurora MySQL 2 in the Amazon RDS User Guide.- engine
Version String The database engine version.
- identifier String
The indentifier for the RDS instance, if omitted, this provider will assign a random, unique identifier.
- identifier
Prefix String Creates a unique identifier beginning with the specified prefix. Conflicts with
identifier
.- monitoring
Interval Number The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
- monitoring
Role StringArn The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
- performance
Insights BooleanEnabled Specifies whether Performance Insights is enabled or not.
- performance
Insights StringKms Key Id 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.- performance
Insights NumberRetention Period Amount of time in days to retain Performance Insights data. Valid values are
7
,731
(2 years) or a multiple of31
. When specifyingperformance_insights_retention_period
,performance_insights_enabled
needs to be set to true. Defaults to '7'.- preferred
Backup StringWindow The daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00". NOTE: If
preferred_backup_window
is set at the cluster level, this argument must be omitted.- preferred
Maintenance StringWindow The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
- promotion
Tier Number Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoted to writer.
- publicly
Accessible Boolean Bool to control if instance is publicly accessible. Default
false
. See the documentation on Creating DB Instances for more details on controlling this property.- Map<String>
A map of tags to assign to the instance. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Outputs
All input properties are implicitly available as output properties. Additionally, the ClusterInstance resource produces the following output properties:
- Arn string
Amazon Resource Name (ARN) of cluster instance
- Dbi
Resource stringId The region-unique, immutable identifier for the DB instance.
- Endpoint string
The DNS address for this instance. May not be writable
- Engine
Version stringActual The database engine version
- Id string
The provider-assigned unique ID for this managed resource.
- Kms
Key stringId The ARN for the KMS encryption key if one is set to the cluster.
- Network
Type string The network type of the DB instance.
- Port int
The database port
- Storage
Encrypted bool Specifies whether the DB cluster is encrypted.
- Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- Writer bool
Boolean indicating if this instance is writable.
False
indicates this instance is a read replica.
- Arn string
Amazon Resource Name (ARN) of cluster instance
- Dbi
Resource stringId The region-unique, immutable identifier for the DB instance.
- Endpoint string
The DNS address for this instance. May not be writable
- Engine
Version stringActual The database engine version
- Id string
The provider-assigned unique ID for this managed resource.
- Kms
Key stringId The ARN for the KMS encryption key if one is set to the cluster.
- Network
Type string The network type of the DB instance.
- Port int
The database port
- Storage
Encrypted bool Specifies whether the DB cluster is encrypted.
- map[string]string
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- Writer bool
Boolean indicating if this instance is writable.
False
indicates this instance is a read replica.
- arn String
Amazon Resource Name (ARN) of cluster instance
- dbi
Resource StringId The region-unique, immutable identifier for the DB instance.
- endpoint String
The DNS address for this instance. May not be writable
- engine
Version StringActual The database engine version
- id String
The provider-assigned unique ID for this managed resource.
- kms
Key StringId The ARN for the KMS encryption key if one is set to the cluster.
- network
Type String The network type of the DB instance.
- port Integer
The database port
- storage
Encrypted Boolean Specifies whether the DB cluster is encrypted.
- Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- writer Boolean
Boolean indicating if this instance is writable.
False
indicates this instance is a read replica.
- arn string
Amazon Resource Name (ARN) of cluster instance
- dbi
Resource stringId The region-unique, immutable identifier for the DB instance.
- endpoint string
The DNS address for this instance. May not be writable
- engine
Version stringActual The database engine version
- id string
The provider-assigned unique ID for this managed resource.
- kms
Key stringId The ARN for the KMS encryption key if one is set to the cluster.
- network
Type string The network type of the DB instance.
- port number
The database port
- storage
Encrypted boolean Specifies whether the DB cluster is encrypted.
- {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- writer boolean
Boolean indicating if this instance is writable.
False
indicates this instance is a read replica.
- arn str
Amazon Resource Name (ARN) of cluster instance
- dbi_
resource_ strid The region-unique, immutable identifier for the DB instance.
- endpoint str
The DNS address for this instance. May not be writable
- engine_
version_ stractual The database engine version
- id str
The provider-assigned unique ID for this managed resource.
- kms_
key_ strid The ARN for the KMS encryption key if one is set to the cluster.
- network_
type str The network type of the DB instance.
- port int
The database port
- storage_
encrypted bool Specifies whether the DB cluster is encrypted.
- Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- writer bool
Boolean indicating if this instance is writable.
False
indicates this instance is a read replica.
- arn String
Amazon Resource Name (ARN) of cluster instance
- dbi
Resource StringId The region-unique, immutable identifier for the DB instance.
- endpoint String
The DNS address for this instance. May not be writable
- engine
Version StringActual The database engine version
- id String
The provider-assigned unique ID for this managed resource.
- kms
Key StringId The ARN for the KMS encryption key if one is set to the cluster.
- network
Type String The network type of the DB instance.
- port Number
The database port
- storage
Encrypted Boolean Specifies whether the DB cluster is encrypted.
- Map<String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- writer Boolean
Boolean indicating if this instance is writable.
False
indicates this instance is a read replica.
Look up Existing ClusterInstance Resource
Get an existing ClusterInstance 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?: ClusterInstanceState, opts?: CustomResourceOptions): ClusterInstance
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
apply_immediately: Optional[bool] = None,
arn: Optional[str] = None,
auto_minor_version_upgrade: Optional[bool] = None,
availability_zone: Optional[str] = None,
ca_cert_identifier: Optional[str] = None,
cluster_identifier: Optional[str] = None,
copy_tags_to_snapshot: Optional[bool] = None,
db_parameter_group_name: Optional[str] = None,
db_subnet_group_name: Optional[str] = None,
dbi_resource_id: Optional[str] = None,
endpoint: Optional[str] = None,
engine: Optional[str] = None,
engine_version: Optional[str] = None,
engine_version_actual: Optional[str] = None,
identifier: Optional[str] = None,
identifier_prefix: Optional[str] = None,
instance_class: Optional[Union[str, InstanceType]] = None,
kms_key_id: Optional[str] = None,
monitoring_interval: Optional[int] = None,
monitoring_role_arn: Optional[str] = None,
network_type: 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,
preferred_backup_window: Optional[str] = None,
preferred_maintenance_window: Optional[str] = None,
promotion_tier: Optional[int] = None,
publicly_accessible: Optional[bool] = None,
storage_encrypted: Optional[bool] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None,
writer: Optional[bool] = None) -> ClusterInstance
func GetClusterInstance(ctx *Context, name string, id IDInput, state *ClusterInstanceState, opts ...ResourceOption) (*ClusterInstance, error)
public static ClusterInstance Get(string name, Input<string> id, ClusterInstanceState? state, CustomResourceOptions? opts = null)
public static ClusterInstance get(String name, Output<String> id, ClusterInstanceState 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.
- Apply
Immediately bool Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is
false
.- Arn string
Amazon Resource Name (ARN) of cluster instance
- Auto
Minor boolVersion Upgrade Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default
true
.- Availability
Zone string The EC2 Availability Zone that the DB instance is created in. See docs about the details.
- Ca
Cert stringIdentifier The identifier of the CA certificate for the DB instance.
- Cluster
Identifier string The identifier of the
aws.rds.Cluster
in which to launch this instance.- bool
Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance. Default
false
.- Db
Parameter stringGroup Name The name of the DB parameter group to associate with this instance.
- Db
Subnet stringGroup Name A DB subnet group to associate with this DB instance. NOTE: This must match the
db_subnet_group_name
of the attachedaws.rds.Cluster
.- Dbi
Resource stringId The region-unique, immutable identifier for the DB instance.
- Endpoint string
The DNS address for this instance. May not be writable
- Engine string
The name of the database engine to be used for the RDS instance. Defaults to
aurora
. Valid Values:aurora
,aurora-mysql
,aurora-postgresql
. For information on the difference between the available Aurora MySQL engines see Comparison between Aurora MySQL 1 and Aurora MySQL 2 in the Amazon RDS User Guide.- Engine
Version string The database engine version.
- Engine
Version stringActual The database engine version
- Identifier string
The indentifier for the RDS instance, if omitted, this provider will assign a random, unique identifier.
- Identifier
Prefix string Creates a unique identifier beginning with the specified prefix. Conflicts with
identifier
.- Instance
Class string | Pulumi.Aws. Rds. Instance Type The instance class to use. For details on CPU and memory, see Scaling Aurora DB Instances. Aurora uses
db.*
instance classes/types. Please see AWS Documentation for currently available instance classes and complete details.- Kms
Key stringId The ARN for the KMS encryption key if one is set to the cluster.
- Monitoring
Interval int The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
- Monitoring
Role stringArn The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
- Network
Type string The network type of the DB instance.
- Performance
Insights boolEnabled Specifies whether Performance Insights is enabled or not.
- Performance
Insights stringKms Key Id 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.- Performance
Insights intRetention Period Amount of time in days to retain Performance Insights data. Valid values are
7
,731
(2 years) or a multiple of31
. When specifyingperformance_insights_retention_period
,performance_insights_enabled
needs to be set to true. Defaults to '7'.- Port int
The database port
- Preferred
Backup stringWindow The daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00". NOTE: If
preferred_backup_window
is set at the cluster level, this argument must be omitted.- Preferred
Maintenance stringWindow The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
- Promotion
Tier int Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoted to writer.
- Publicly
Accessible bool Bool to control if instance is publicly accessible. Default
false
. See the documentation on Creating DB Instances for more details on controlling this property.- Storage
Encrypted bool Specifies whether the DB cluster is encrypted.
- Dictionary<string, string>
A map of tags to assign to the instance. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- Writer bool
Boolean indicating if this instance is writable.
False
indicates this instance is a read replica.
- Apply
Immediately bool Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is
false
.- Arn string
Amazon Resource Name (ARN) of cluster instance
- Auto
Minor boolVersion Upgrade Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default
true
.- Availability
Zone string The EC2 Availability Zone that the DB instance is created in. See docs about the details.
- Ca
Cert stringIdentifier The identifier of the CA certificate for the DB instance.
- Cluster
Identifier string The identifier of the
aws.rds.Cluster
in which to launch this instance.- bool
Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance. Default
false
.- Db
Parameter stringGroup Name The name of the DB parameter group to associate with this instance.
- Db
Subnet stringGroup Name A DB subnet group to associate with this DB instance. NOTE: This must match the
db_subnet_group_name
of the attachedaws.rds.Cluster
.- Dbi
Resource stringId The region-unique, immutable identifier for the DB instance.
- Endpoint string
The DNS address for this instance. May not be writable
- Engine string
The name of the database engine to be used for the RDS instance. Defaults to
aurora
. Valid Values:aurora
,aurora-mysql
,aurora-postgresql
. For information on the difference between the available Aurora MySQL engines see Comparison between Aurora MySQL 1 and Aurora MySQL 2 in the Amazon RDS User Guide.- Engine
Version string The database engine version.
- Engine
Version stringActual The database engine version
- Identifier string
The indentifier for the RDS instance, if omitted, this provider will assign a random, unique identifier.
- Identifier
Prefix string Creates a unique identifier beginning with the specified prefix. Conflicts with
identifier
.- Instance
Class string | InstanceType The instance class to use. For details on CPU and memory, see Scaling Aurora DB Instances. Aurora uses
db.*
instance classes/types. Please see AWS Documentation for currently available instance classes and complete details.- Kms
Key stringId The ARN for the KMS encryption key if one is set to the cluster.
- Monitoring
Interval int The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
- Monitoring
Role stringArn The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
- Network
Type string The network type of the DB instance.
- Performance
Insights boolEnabled Specifies whether Performance Insights is enabled or not.
- Performance
Insights stringKms Key Id 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.- Performance
Insights intRetention Period Amount of time in days to retain Performance Insights data. Valid values are
7
,731
(2 years) or a multiple of31
. When specifyingperformance_insights_retention_period
,performance_insights_enabled
needs to be set to true. Defaults to '7'.- Port int
The database port
- Preferred
Backup stringWindow The daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00". NOTE: If
preferred_backup_window
is set at the cluster level, this argument must be omitted.- Preferred
Maintenance stringWindow The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
- Promotion
Tier int Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoted to writer.
- Publicly
Accessible bool Bool to control if instance is publicly accessible. Default
false
. See the documentation on Creating DB Instances for more details on controlling this property.- Storage
Encrypted bool Specifies whether the DB cluster is encrypted.
- map[string]string
A map of tags to assign to the instance. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- map[string]string
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- Writer bool
Boolean indicating if this instance is writable.
False
indicates this instance is a read replica.
- apply
Immediately Boolean Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is
false
.- arn String
Amazon Resource Name (ARN) of cluster instance
- auto
Minor BooleanVersion Upgrade Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default
true
.- availability
Zone String The EC2 Availability Zone that the DB instance is created in. See docs about the details.
- ca
Cert StringIdentifier The identifier of the CA certificate for the DB instance.
- cluster
Identifier String The identifier of the
aws.rds.Cluster
in which to launch this instance.- Boolean
Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance. Default
false
.- db
Parameter StringGroup Name The name of the DB parameter group to associate with this instance.
- db
Subnet StringGroup Name A DB subnet group to associate with this DB instance. NOTE: This must match the
db_subnet_group_name
of the attachedaws.rds.Cluster
.- dbi
Resource StringId The region-unique, immutable identifier for the DB instance.
- endpoint String
The DNS address for this instance. May not be writable
- engine String
The name of the database engine to be used for the RDS instance. Defaults to
aurora
. Valid Values:aurora
,aurora-mysql
,aurora-postgresql
. For information on the difference between the available Aurora MySQL engines see Comparison between Aurora MySQL 1 and Aurora MySQL 2 in the Amazon RDS User Guide.- engine
Version String The database engine version.
- engine
Version StringActual The database engine version
- identifier String
The indentifier for the RDS instance, if omitted, this provider will assign a random, unique identifier.
- identifier
Prefix String Creates a unique identifier beginning with the specified prefix. Conflicts with
identifier
.- instance
Class String | InstanceType The instance class to use. For details on CPU and memory, see Scaling Aurora DB Instances. Aurora uses
db.*
instance classes/types. Please see AWS Documentation for currently available instance classes and complete details.- kms
Key StringId The ARN for the KMS encryption key if one is set to the cluster.
- monitoring
Interval Integer The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
- monitoring
Role StringArn The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
- network
Type String The network type of the DB instance.
- performance
Insights BooleanEnabled Specifies whether Performance Insights is enabled or not.
- performance
Insights StringKms Key Id 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.- performance
Insights IntegerRetention Period Amount of time in days to retain Performance Insights data. Valid values are
7
,731
(2 years) or a multiple of31
. When specifyingperformance_insights_retention_period
,performance_insights_enabled
needs to be set to true. Defaults to '7'.- port Integer
The database port
- preferred
Backup StringWindow The daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00". NOTE: If
preferred_backup_window
is set at the cluster level, this argument must be omitted.- preferred
Maintenance StringWindow The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
- promotion
Tier Integer Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoted to writer.
- publicly
Accessible Boolean Bool to control if instance is publicly accessible. Default
false
. See the documentation on Creating DB Instances for more details on controlling this property.- storage
Encrypted Boolean Specifies whether the DB cluster is encrypted.
- Map<String,String>
A map of tags to assign to the instance. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- writer Boolean
Boolean indicating if this instance is writable.
False
indicates this instance is a read replica.
- apply
Immediately boolean Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is
false
.- arn string
Amazon Resource Name (ARN) of cluster instance
- auto
Minor booleanVersion Upgrade Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default
true
.- availability
Zone string The EC2 Availability Zone that the DB instance is created in. See docs about the details.
- ca
Cert stringIdentifier The identifier of the CA certificate for the DB instance.
- cluster
Identifier string The identifier of the
aws.rds.Cluster
in which to launch this instance.- boolean
Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance. Default
false
.- db
Parameter stringGroup Name The name of the DB parameter group to associate with this instance.
- db
Subnet stringGroup Name A DB subnet group to associate with this DB instance. NOTE: This must match the
db_subnet_group_name
of the attachedaws.rds.Cluster
.- dbi
Resource stringId The region-unique, immutable identifier for the DB instance.
- endpoint string
The DNS address for this instance. May not be writable
- engine
Engine
Type The name of the database engine to be used for the RDS instance. Defaults to
aurora
. Valid Values:aurora
,aurora-mysql
,aurora-postgresql
. For information on the difference between the available Aurora MySQL engines see Comparison between Aurora MySQL 1 and Aurora MySQL 2 in the Amazon RDS User Guide.- engine
Version string The database engine version.
- engine
Version stringActual The database engine version
- identifier string
The indentifier for the RDS instance, if omitted, this provider will assign a random, unique identifier.
- identifier
Prefix string Creates a unique identifier beginning with the specified prefix. Conflicts with
identifier
.- instance
Class string | InstanceType The instance class to use. For details on CPU and memory, see Scaling Aurora DB Instances. Aurora uses
db.*
instance classes/types. Please see AWS Documentation for currently available instance classes and complete details.- kms
Key stringId The ARN for the KMS encryption key if one is set to the cluster.
- monitoring
Interval number The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
- monitoring
Role stringArn The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
- network
Type string The network type of the DB instance.
- performance
Insights booleanEnabled Specifies whether Performance Insights is enabled or not.
- performance
Insights stringKms Key Id 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.- performance
Insights numberRetention Period Amount of time in days to retain Performance Insights data. Valid values are
7
,731
(2 years) or a multiple of31
. When specifyingperformance_insights_retention_period
,performance_insights_enabled
needs to be set to true. Defaults to '7'.- port number
The database port
- preferred
Backup stringWindow The daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00". NOTE: If
preferred_backup_window
is set at the cluster level, this argument must be omitted.- preferred
Maintenance stringWindow The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
- promotion
Tier number Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoted to writer.
- publicly
Accessible boolean Bool to control if instance is publicly accessible. Default
false
. See the documentation on Creating DB Instances for more details on controlling this property.- storage
Encrypted boolean Specifies whether the DB cluster is encrypted.
- {[key: string]: string}
A map of tags to assign to the instance. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- writer boolean
Boolean indicating if this instance is writable.
False
indicates this instance is a read replica.
- apply_
immediately bool Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is
false
.- arn str
Amazon Resource Name (ARN) of cluster instance
- auto_
minor_ boolversion_ upgrade Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default
true
.- availability_
zone str The EC2 Availability Zone that the DB instance is created in. See docs about the details.
- ca_
cert_ stridentifier The identifier of the CA certificate for the DB instance.
- cluster_
identifier str The identifier of the
aws.rds.Cluster
in which to launch this instance.- bool
Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance. Default
false
.- db_
parameter_ strgroup_ name The name of the DB parameter group to associate with this instance.
- db_
subnet_ strgroup_ name A DB subnet group to associate with this DB instance. NOTE: This must match the
db_subnet_group_name
of the attachedaws.rds.Cluster
.- dbi_
resource_ strid The region-unique, immutable identifier for the DB instance.
- endpoint str
The DNS address for this instance. May not be writable
- engine str
The name of the database engine to be used for the RDS instance. Defaults to
aurora
. Valid Values:aurora
,aurora-mysql
,aurora-postgresql
. 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 database engine version.
- engine_
version_ stractual The database engine version
- identifier str
The indentifier for 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 str | InstanceType The instance class to use. For details on CPU and memory, see Scaling Aurora DB Instances. Aurora uses
db.*
instance classes/types. Please see AWS Documentation for currently available instance classes and complete details.- kms_
key_ strid The ARN for the KMS encryption key if one is set to the cluster.
- monitoring_
interval int The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
- monitoring_
role_ strarn The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
- network_
type str The network type of the DB instance.
- performance_
insights_ boolenabled Specifies whether Performance Insights is enabled or not.
- performance_
insights_ strkms_ key_ id 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.- performance_
insights_ intretention_ period Amount of time in days to retain Performance Insights data. Valid values are
7
,731
(2 years) or a multiple of31
. When specifyingperformance_insights_retention_period
,performance_insights_enabled
needs to be set to true. Defaults to '7'.- port int
The database port
- preferred_
backup_ strwindow The daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00". NOTE: If
preferred_backup_window
is set at the cluster level, this argument must be omitted.- preferred_
maintenance_ strwindow The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
- promotion_
tier int Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoted to writer.
- publicly_
accessible bool Bool to control if instance is publicly accessible. Default
false
. See the documentation on Creating DB Instances for more details on controlling this property.- storage_
encrypted bool Specifies whether the DB cluster is encrypted.
- Mapping[str, str]
A map of tags to assign to the instance. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- writer bool
Boolean indicating if this instance is writable.
False
indicates this instance is a read replica.
- apply
Immediately Boolean Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is
false
.- arn String
Amazon Resource Name (ARN) of cluster instance
- auto
Minor BooleanVersion Upgrade Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default
true
.- availability
Zone String The EC2 Availability Zone that the DB instance is created in. See docs about the details.
- ca
Cert StringIdentifier The identifier of the CA certificate for the DB instance.
- cluster
Identifier String The identifier of the
aws.rds.Cluster
in which to launch this instance.- Boolean
Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance. Default
false
.- db
Parameter StringGroup Name The name of the DB parameter group to associate with this instance.
- db
Subnet StringGroup Name A DB subnet group to associate with this DB instance. NOTE: This must match the
db_subnet_group_name
of the attachedaws.rds.Cluster
.- dbi
Resource StringId The region-unique, immutable identifier for the DB instance.
- endpoint String
The DNS address for this instance. May not be writable
- engine
The name of the database engine to be used for the RDS instance. Defaults to
aurora
. Valid Values:aurora
,aurora-mysql
,aurora-postgresql
. For information on the difference between the available Aurora MySQL engines see Comparison between Aurora MySQL 1 and Aurora MySQL 2 in the Amazon RDS User Guide.- engine
Version String The database engine version.
- engine
Version StringActual The database engine version
- identifier String
The indentifier for the RDS instance, if omitted, this provider will assign a random, unique identifier.
- identifier
Prefix String Creates a unique identifier beginning with the specified prefix. Conflicts with
identifier
.- instance
Class String | "db.t4g.micro" | "db.t4g.small" | "db.t4g.medium" | "db.t4g.large" | "db.t4g.xlarge" | "db.t4g.2xlarge" | "db.t3.micro" | "db.t3.small" | "db.t3.medium" | "db.t3.large" | "db.t3.xlarge" | "db.t3.2xlarge" | "db.t2.micro" | "db.t2.small" | "db.t2.medium" | "db.t2.large" | "db.t2.xlarge" | "db.t2.2xlarge" | "db.m1.small" | "db.m1.medium" | "db.m1.large" | "db.m1.xlarge" | "db.m2.xlarge" | "db.m2.2xlarge" | "db.m2.4xlarge" | "db.m3.medium" | "db.m3.large" | "db.m3.xlarge" | "db.m3.2xlarge" | "db.m4.large" | "db.m4.xlarge" | "db.m4.2xlarge" | "db.m4.4xlarge" | "db.m4.10xlarge" | "db.m4.10xlarge" | "db.m5.large" | "db.m5.xlarge" | "db.m5.2xlarge" | "db.m5.4xlarge" | "db.m5.12xlarge" | "db.m5.24xlarge" | "db.m6g.large" | "db.m6g.xlarge" | "db.m6g.2xlarge" | "db.m6g.4xlarge" | "db.m6g.8xlarge" | "db.m6g.12xlarge" | "db.m6g.16xlarge" | "db.r3.large" | "db.r3.xlarge" | "db.r3.2xlarge" | "db.r3.4xlarge" | "db.r3.8xlarge" | "db.r4.large" | "db.r4.xlarge" | "db.r4.2xlarge" | "db.r4.4xlarge" | "db.r4.8xlarge" | "db.r4.16xlarge" | "db.r5.large" | "db.r5.xlarge" | "db.r5.2xlarge" | "db.r5.4xlarge" | "db.r5.12xlarge" | "db.r5.24xlarge" | "db.r6g.large" | "db.r6g.xlarge" | "db.r6g.2xlarge" | "db.r6g.4xlarge" | "db.r6g.8xlarge" | "db.r6g.12xlarge" | "db.r6g.16xlarge" | "db.x1.16xlarge" | "db.x1.32xlarge" | "db.x1e.xlarge" | "db.x1e.2xlarge" | "db.x1e.4xlarge" | "db.x1e.8xlarge" | "db.x1e.32xlarge" The instance class to use. For details on CPU and memory, see Scaling Aurora DB Instances. Aurora uses
db.*
instance classes/types. Please see AWS Documentation for currently available instance classes and complete details.- kms
Key StringId The ARN for the KMS encryption key if one is set to the cluster.
- monitoring
Interval Number The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
- monitoring
Role StringArn The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
- network
Type String The network type of the DB instance.
- performance
Insights BooleanEnabled Specifies whether Performance Insights is enabled or not.
- performance
Insights StringKms Key Id 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.- performance
Insights NumberRetention Period Amount of time in days to retain Performance Insights data. Valid values are
7
,731
(2 years) or a multiple of31
. When specifyingperformance_insights_retention_period
,performance_insights_enabled
needs to be set to true. Defaults to '7'.- port Number
The database port
- preferred
Backup StringWindow The daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00". NOTE: If
preferred_backup_window
is set at the cluster level, this argument must be omitted.- preferred
Maintenance StringWindow The window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
- promotion
Tier Number Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoted to writer.
- publicly
Accessible Boolean Bool to control if instance is publicly accessible. Default
false
. See the documentation on Creating DB Instances for more details on controlling this property.- storage
Encrypted Boolean Specifies whether the DB cluster is encrypted.
- Map<String>
A map of tags to assign to the instance. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- Map<String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- writer Boolean
Boolean indicating if this instance is writable.
False
indicates this instance is a read replica.
Supporting Types
InstanceType
- T4G_Micro
- db.t4g.micro
- T4G_Small
- db.t4g.small
- T4G_Medium
- db.t4g.medium
- T4G_Large
- db.t4g.large
- T4G_XLarge
- db.t4g.xlarge
- T4G_2XLarge
- db.t4g.2xlarge
- T3_Micro
- db.t3.micro
- T3_Small
- db.t3.small
- T3_Medium
- db.t3.medium
- T3_Large
- db.t3.large
- T3_XLarge
- db.t3.xlarge
- T3_2XLarge
- db.t3.2xlarge
- T2_Micro
- db.t2.micro
- T2_Small
- db.t2.small
- T2_Medium
- db.t2.medium
- T2_Large
- db.t2.large
- T2_XLarge
- db.t2.xlarge
- T2_2XLarge
- db.t2.2xlarge
- M1_Small
- db.m1.small
- M1_Medium
- db.m1.medium
- M1_Large
- db.m1.large
- M1_XLarge
- db.m1.xlarge
- M2_XLarge
- db.m2.xlarge
- M2_2XLarge
- db.m2.2xlarge
- M2_4XLarge
- db.m2.4xlarge
- M3_Medium
- db.m3.medium
- M3_Large
- db.m3.large
- M3_XLarge
- db.m3.xlarge
- M3_2XLarge
- db.m3.2xlarge
- M4_Large
- db.m4.large
- M4_XLarge
- db.m4.xlarge
- M4_2XLarge
- db.m4.2xlarge
- M4_4XLarge
- db.m4.4xlarge
- M4_10XLarge
- db.m4.10xlarge
- M4_16XLarge
- db.m4.10xlarge
- M5_Large
- db.m5.large
- M5_XLarge
- db.m5.xlarge
- M5_2XLarge
- db.m5.2xlarge
- M5_4XLarge
- db.m5.4xlarge
- M5_12XLarge
- db.m5.12xlarge
- M5_24XLarge
- db.m5.24xlarge
- M6G_Large
- db.m6g.large
- M6G_XLarge
- db.m6g.xlarge
- M6G_2XLarge
- db.m6g.2xlarge
- M6G_4XLarge
- db.m6g.4xlarge
- M6G_8XLarge
- db.m6g.8xlarge
- M6G_12XLarge
- db.m6g.12xlarge
- M6G_16XLarge
- db.m6g.16xlarge
- R3_Large
- db.r3.large
- R3_XLarge
- db.r3.xlarge
- R3_2XLarge
- db.r3.2xlarge
- R3_4XLarge
- db.r3.4xlarge
- R3_8XLarge
- db.r3.8xlarge
- R4_Large
- db.r4.large
- R4_XLarge
- db.r4.xlarge
- R4_2XLarge
- db.r4.2xlarge
- R4_4XLarge
- db.r4.4xlarge
- R4_8XLarge
- db.r4.8xlarge
- R4_16XLarge
- db.r4.16xlarge
- R5_Large
- db.r5.large
- R5_XLarge
- db.r5.xlarge
- R5_2XLarge
- db.r5.2xlarge
- R5_4XLarge
- db.r5.4xlarge
- R5_12XLarge
- db.r5.12xlarge
- R5_24XLarge
- db.r5.24xlarge
- R6G_Large
- db.r6g.large
- R6G_XLarge
- db.r6g.xlarge
- R6G_2XLarge
- db.r6g.2xlarge
- R6G_4XLarge
- db.r6g.4xlarge
- R6G_8XLarge
- db.r6g.8xlarge
- R6G_12XLarge
- db.r6g.12xlarge
- R6G_16XLarge
- db.r6g.16xlarge
- X1_16XLarge
- db.x1.16xlarge
- X1_32XLarge
- db.x1.32xlarge
- X1E_XLarge
- db.x1e.xlarge
- X1E_2XLarge
- db.x1e.2xlarge
- X1E_4XLarge
- db.x1e.4xlarge
- X1E_8XLarge
- db.x1e.8xlarge
- X1E_32XLarge
- db.x1e.32xlarge
- Instance
Type_T4G_Micro - db.t4g.micro
- Instance
Type_T4G_Small - db.t4g.small
- Instance
Type_T4G_Medium - db.t4g.medium
- Instance
Type_T4G_Large - db.t4g.large
- Instance
Type_T4G_XLarge - db.t4g.xlarge
- Instance
Type_T4G_2XLarge - db.t4g.2xlarge
- Instance
Type_T3_Micro - db.t3.micro
- Instance
Type_T3_Small - db.t3.small
- Instance
Type_T3_Medium - db.t3.medium
- Instance
Type_T3_Large - db.t3.large
- Instance
Type_T3_XLarge - db.t3.xlarge
- Instance
Type_T3_2XLarge - db.t3.2xlarge
- Instance
Type_T2_Micro - db.t2.micro
- Instance
Type_T2_Small - db.t2.small
- Instance
Type_T2_Medium - db.t2.medium
- Instance
Type_T2_Large - db.t2.large
- Instance
Type_T2_XLarge - db.t2.xlarge
- Instance
Type_T2_2XLarge - db.t2.2xlarge
- Instance
Type_M1_Small - db.m1.small
- Instance
Type_M1_Medium - db.m1.medium
- Instance
Type_M1_Large - db.m1.large
- Instance
Type_M1_XLarge - db.m1.xlarge
- Instance
Type_M2_XLarge - db.m2.xlarge
- Instance
Type_M2_2XLarge - db.m2.2xlarge
- Instance
Type_M2_4XLarge - db.m2.4xlarge
- Instance
Type_M3_Medium - db.m3.medium
- Instance
Type_M3_Large - db.m3.large
- Instance
Type_M3_XLarge - db.m3.xlarge
- Instance
Type_M3_2XLarge - db.m3.2xlarge
- Instance
Type_M4_Large - db.m4.large
- Instance
Type_M4_XLarge - db.m4.xlarge
- Instance
Type_M4_2XLarge - db.m4.2xlarge
- Instance
Type_M4_4XLarge - db.m4.4xlarge
- Instance
Type_M4_10XLarge - db.m4.10xlarge
- Instance
Type_M4_16XLarge - db.m4.10xlarge
- Instance
Type_M5_Large - db.m5.large
- Instance
Type_M5_XLarge - db.m5.xlarge
- Instance
Type_M5_2XLarge - db.m5.2xlarge
- Instance
Type_M5_4XLarge - db.m5.4xlarge
- Instance
Type_M5_12XLarge - db.m5.12xlarge
- Instance
Type_M5_24XLarge - db.m5.24xlarge
- Instance
Type_M6G_Large - db.m6g.large
- Instance
Type_M6G_XLarge - db.m6g.xlarge
- Instance
Type_M6G_2XLarge - db.m6g.2xlarge
- Instance
Type_M6G_4XLarge - db.m6g.4xlarge
- Instance
Type_M6G_8XLarge - db.m6g.8xlarge
- Instance
Type_M6G_12XLarge - db.m6g.12xlarge
- Instance
Type_M6G_16XLarge - db.m6g.16xlarge
- Instance
Type_R3_Large - db.r3.large
- Instance
Type_R3_XLarge - db.r3.xlarge
- Instance
Type_R3_2XLarge - db.r3.2xlarge
- Instance
Type_R3_4XLarge - db.r3.4xlarge
- Instance
Type_R3_8XLarge - db.r3.8xlarge
- Instance
Type_R4_Large - db.r4.large
- Instance
Type_R4_XLarge - db.r4.xlarge
- Instance
Type_R4_2XLarge - db.r4.2xlarge
- Instance
Type_R4_4XLarge - db.r4.4xlarge
- Instance
Type_R4_8XLarge - db.r4.8xlarge
- Instance
Type_R4_16XLarge - db.r4.16xlarge
- Instance
Type_R5_Large - db.r5.large
- Instance
Type_R5_XLarge - db.r5.xlarge
- Instance
Type_R5_2XLarge - db.r5.2xlarge
- Instance
Type_R5_4XLarge - db.r5.4xlarge
- Instance
Type_R5_12XLarge - db.r5.12xlarge
- Instance
Type_R5_24XLarge - db.r5.24xlarge
- Instance
Type_R6G_Large - db.r6g.large
- Instance
Type_R6G_XLarge - db.r6g.xlarge
- Instance
Type_R6G_2XLarge - db.r6g.2xlarge
- Instance
Type_R6G_4XLarge - db.r6g.4xlarge
- Instance
Type_R6G_8XLarge - db.r6g.8xlarge
- Instance
Type_R6G_12XLarge - db.r6g.12xlarge
- Instance
Type_R6G_16XLarge - db.r6g.16xlarge
- Instance
Type_X1_16XLarge - db.x1.16xlarge
- Instance
Type_X1_32XLarge - db.x1.32xlarge
- Instance
Type_X1E_XLarge - db.x1e.xlarge
- Instance
Type_X1E_2XLarge - db.x1e.2xlarge
- Instance
Type_X1E_4XLarge - db.x1e.4xlarge
- Instance
Type_X1E_8XLarge - db.x1e.8xlarge
- Instance
Type_X1E_32XLarge - db.x1e.32xlarge
- T4G_Micro
- db.t4g.micro
- T4G_Small
- db.t4g.small
- T4G_Medium
- db.t4g.medium
- T4G_Large
- db.t4g.large
- T4G_XLarge
- db.t4g.xlarge
- T4G_2XLarge
- db.t4g.2xlarge
- T3_Micro
- db.t3.micro
- T3_Small
- db.t3.small
- T3_Medium
- db.t3.medium
- T3_Large
- db.t3.large
- T3_XLarge
- db.t3.xlarge
- T3_2XLarge
- db.t3.2xlarge
- T2_Micro
- db.t2.micro
- T2_Small
- db.t2.small
- T2_Medium
- db.t2.medium
- T2_Large
- db.t2.large
- T2_XLarge
- db.t2.xlarge
- T2_2XLarge
- db.t2.2xlarge
- M1_Small
- db.m1.small
- M1_Medium
- db.m1.medium
- M1_Large
- db.m1.large
- M1_XLarge
- db.m1.xlarge
- M2_XLarge
- db.m2.xlarge
- M2_2XLarge
- db.m2.2xlarge
- M2_4XLarge
- db.m2.4xlarge
- M3_Medium
- db.m3.medium
- M3_Large
- db.m3.large
- M3_XLarge
- db.m3.xlarge
- M3_2XLarge
- db.m3.2xlarge
- M4_Large
- db.m4.large
- M4_XLarge
- db.m4.xlarge
- M4_2XLarge
- db.m4.2xlarge
- M4_4XLarge
- db.m4.4xlarge
- M4_10XLarge
- db.m4.10xlarge
- M4_16XLarge
- db.m4.10xlarge
- M5_Large
- db.m5.large
- M5_XLarge
- db.m5.xlarge
- M5_2XLarge
- db.m5.2xlarge
- M5_4XLarge
- db.m5.4xlarge
- M5_12XLarge
- db.m5.12xlarge
- M5_24XLarge
- db.m5.24xlarge
- M6G_Large
- db.m6g.large
- M6G_XLarge
- db.m6g.xlarge
- M6G_2XLarge
- db.m6g.2xlarge
- M6G_4XLarge
- db.m6g.4xlarge
- M6G_8XLarge
- db.m6g.8xlarge
- M6G_12XLarge
- db.m6g.12xlarge
- M6G_16XLarge
- db.m6g.16xlarge
- R3_Large
- db.r3.large
- R3_XLarge
- db.r3.xlarge
- R3_2XLarge
- db.r3.2xlarge
- R3_4XLarge
- db.r3.4xlarge
- R3_8XLarge
- db.r3.8xlarge
- R4_Large
- db.r4.large
- R4_XLarge
- db.r4.xlarge
- R4_2XLarge
- db.r4.2xlarge
- R4_4XLarge
- db.r4.4xlarge
- R4_8XLarge
- db.r4.8xlarge
- R4_16XLarge
- db.r4.16xlarge
- R5_Large
- db.r5.large
- R5_XLarge
- db.r5.xlarge
- R5_2XLarge
- db.r5.2xlarge
- R5_4XLarge
- db.r5.4xlarge
- R5_12XLarge
- db.r5.12xlarge
- R5_24XLarge
- db.r5.24xlarge
- R6G_Large
- db.r6g.large
- R6G_XLarge
- db.r6g.xlarge
- R6G_2XLarge
- db.r6g.2xlarge
- R6G_4XLarge
- db.r6g.4xlarge
- R6G_8XLarge
- db.r6g.8xlarge
- R6G_12XLarge
- db.r6g.12xlarge
- R6G_16XLarge
- db.r6g.16xlarge
- X1_16XLarge
- db.x1.16xlarge
- X1_32XLarge
- db.x1.32xlarge
- X1E_XLarge
- db.x1e.xlarge
- X1E_2XLarge
- db.x1e.2xlarge
- X1E_4XLarge
- db.x1e.4xlarge
- X1E_8XLarge
- db.x1e.8xlarge
- X1E_32XLarge
- db.x1e.32xlarge
- T4G_Micro
- db.t4g.micro
- T4G_Small
- db.t4g.small
- T4G_Medium
- db.t4g.medium
- T4G_Large
- db.t4g.large
- T4G_XLarge
- db.t4g.xlarge
- T4G_2XLarge
- db.t4g.2xlarge
- T3_Micro
- db.t3.micro
- T3_Small
- db.t3.small
- T3_Medium
- db.t3.medium
- T3_Large
- db.t3.large
- T3_XLarge
- db.t3.xlarge
- T3_2XLarge
- db.t3.2xlarge
- T2_Micro
- db.t2.micro
- T2_Small
- db.t2.small
- T2_Medium
- db.t2.medium
- T2_Large
- db.t2.large
- T2_XLarge
- db.t2.xlarge
- T2_2XLarge
- db.t2.2xlarge
- M1_Small
- db.m1.small
- M1_Medium
- db.m1.medium
- M1_Large
- db.m1.large
- M1_XLarge
- db.m1.xlarge
- M2_XLarge
- db.m2.xlarge
- M2_2XLarge
- db.m2.2xlarge
- M2_4XLarge
- db.m2.4xlarge
- M3_Medium
- db.m3.medium
- M3_Large
- db.m3.large
- M3_XLarge
- db.m3.xlarge
- M3_2XLarge
- db.m3.2xlarge
- M4_Large
- db.m4.large
- M4_XLarge
- db.m4.xlarge
- M4_2XLarge
- db.m4.2xlarge
- M4_4XLarge
- db.m4.4xlarge
- M4_10XLarge
- db.m4.10xlarge
- M4_16XLarge
- db.m4.10xlarge
- M5_Large
- db.m5.large
- M5_XLarge
- db.m5.xlarge
- M5_2XLarge
- db.m5.2xlarge
- M5_4XLarge
- db.m5.4xlarge
- M5_12XLarge
- db.m5.12xlarge
- M5_24XLarge
- db.m5.24xlarge
- M6G_Large
- db.m6g.large
- M6G_XLarge
- db.m6g.xlarge
- M6G_2XLarge
- db.m6g.2xlarge
- M6G_4XLarge
- db.m6g.4xlarge
- M6G_8XLarge
- db.m6g.8xlarge
- M6G_12XLarge
- db.m6g.12xlarge
- M6G_16XLarge
- db.m6g.16xlarge
- R3_Large
- db.r3.large
- R3_XLarge
- db.r3.xlarge
- R3_2XLarge
- db.r3.2xlarge
- R3_4XLarge
- db.r3.4xlarge
- R3_8XLarge
- db.r3.8xlarge
- R4_Large
- db.r4.large
- R4_XLarge
- db.r4.xlarge
- R4_2XLarge
- db.r4.2xlarge
- R4_4XLarge
- db.r4.4xlarge
- R4_8XLarge
- db.r4.8xlarge
- R4_16XLarge
- db.r4.16xlarge
- R5_Large
- db.r5.large
- R5_XLarge
- db.r5.xlarge
- R5_2XLarge
- db.r5.2xlarge
- R5_4XLarge
- db.r5.4xlarge
- R5_12XLarge
- db.r5.12xlarge
- R5_24XLarge
- db.r5.24xlarge
- R6G_Large
- db.r6g.large
- R6G_XLarge
- db.r6g.xlarge
- R6G_2XLarge
- db.r6g.2xlarge
- R6G_4XLarge
- db.r6g.4xlarge
- R6G_8XLarge
- db.r6g.8xlarge
- R6G_12XLarge
- db.r6g.12xlarge
- R6G_16XLarge
- db.r6g.16xlarge
- X1_16XLarge
- db.x1.16xlarge
- X1_32XLarge
- db.x1.32xlarge
- X1E_XLarge
- db.x1e.xlarge
- X1E_2XLarge
- db.x1e.2xlarge
- X1E_4XLarge
- db.x1e.4xlarge
- X1E_8XLarge
- db.x1e.8xlarge
- X1E_32XLarge
- db.x1e.32xlarge
- T4_G_MICRO
- db.t4g.micro
- T4_G_SMALL
- db.t4g.small
- T4_G_MEDIUM
- db.t4g.medium
- T4_G_LARGE
- db.t4g.large
- T4_G_X_LARGE
- db.t4g.xlarge
- T4_G_2_X_LARGE
- db.t4g.2xlarge
- T3_MICRO
- db.t3.micro
- T3_SMALL
- db.t3.small
- T3_MEDIUM
- db.t3.medium
- T3_LARGE
- db.t3.large
- T3_X_LARGE
- db.t3.xlarge
- T3_2_X_LARGE
- db.t3.2xlarge
- T2_MICRO
- db.t2.micro
- T2_SMALL
- db.t2.small
- T2_MEDIUM
- db.t2.medium
- T2_LARGE
- db.t2.large
- T2_X_LARGE
- db.t2.xlarge
- T2_2_X_LARGE
- db.t2.2xlarge
- M1_SMALL
- db.m1.small
- M1_MEDIUM
- db.m1.medium
- M1_LARGE
- db.m1.large
- M1_X_LARGE
- db.m1.xlarge
- M2_X_LARGE
- db.m2.xlarge
- M2_2_X_LARGE
- db.m2.2xlarge
- M2_4_X_LARGE
- db.m2.4xlarge
- M3_MEDIUM
- db.m3.medium
- M3_LARGE
- db.m3.large
- M3_X_LARGE
- db.m3.xlarge
- M3_2_X_LARGE
- db.m3.2xlarge
- M4_LARGE
- db.m4.large
- M4_X_LARGE
- db.m4.xlarge
- M4_2_X_LARGE
- db.m4.2xlarge
- M4_4_X_LARGE
- db.m4.4xlarge
- M4_10_X_LARGE
- db.m4.10xlarge
- M4_16_X_LARGE
- db.m4.10xlarge
- M5_LARGE
- db.m5.large
- M5_X_LARGE
- db.m5.xlarge
- M5_2_X_LARGE
- db.m5.2xlarge
- M5_4_X_LARGE
- db.m5.4xlarge
- M5_12_X_LARGE
- db.m5.12xlarge
- M5_24_X_LARGE
- db.m5.24xlarge
- M6_G_LARGE
- db.m6g.large
- M6_G_X_LARGE
- db.m6g.xlarge
- M6_G_2_X_LARGE
- db.m6g.2xlarge
- M6_G_4_X_LARGE
- db.m6g.4xlarge
- M6_G_8_X_LARGE
- db.m6g.8xlarge
- M6_G_12_X_LARGE
- db.m6g.12xlarge
- M6_G_16_X_LARGE
- db.m6g.16xlarge
- R3_LARGE
- db.r3.large
- R3_X_LARGE
- db.r3.xlarge
- R3_2_X_LARGE
- db.r3.2xlarge
- R3_4_X_LARGE
- db.r3.4xlarge
- R3_8_X_LARGE
- db.r3.8xlarge
- R4_LARGE
- db.r4.large
- R4_X_LARGE
- db.r4.xlarge
- R4_2_X_LARGE
- db.r4.2xlarge
- R4_4_X_LARGE
- db.r4.4xlarge
- R4_8_X_LARGE
- db.r4.8xlarge
- R4_16_X_LARGE
- db.r4.16xlarge
- R5_LARGE
- db.r5.large
- R5_X_LARGE
- db.r5.xlarge
- R5_2_X_LARGE
- db.r5.2xlarge
- R5_4_X_LARGE
- db.r5.4xlarge
- R5_12_X_LARGE
- db.r5.12xlarge
- R5_24_X_LARGE
- db.r5.24xlarge
- R6_G_LARGE
- db.r6g.large
- R6_G_X_LARGE
- db.r6g.xlarge
- R6_G_2_X_LARGE
- db.r6g.2xlarge
- R6_G_4_X_LARGE
- db.r6g.4xlarge
- R6_G_8_X_LARGE
- db.r6g.8xlarge
- R6_G_12_X_LARGE
- db.r6g.12xlarge
- R6_G_16_X_LARGE
- db.r6g.16xlarge
- X1_16_X_LARGE
- db.x1.16xlarge
- X1_32_X_LARGE
- db.x1.32xlarge
- X1_E_X_LARGE
- db.x1e.xlarge
- X1_E_2_X_LARGE
- db.x1e.2xlarge
- X1_E_4_X_LARGE
- db.x1e.4xlarge
- X1_E_8_X_LARGE
- db.x1e.8xlarge
- X1_E_32_X_LARGE
- db.x1e.32xlarge
- "db.t4g.micro"
- db.t4g.micro
- "db.t4g.small"
- db.t4g.small
- "db.t4g.medium"
- db.t4g.medium
- "db.t4g.large"
- db.t4g.large
- "db.t4g.xlarge"
- db.t4g.xlarge
- "db.t4g.2xlarge"
- db.t4g.2xlarge
- "db.t3.micro"
- db.t3.micro
- "db.t3.small"
- db.t3.small
- "db.t3.medium"
- db.t3.medium
- "db.t3.large"
- db.t3.large
- "db.t3.xlarge"
- db.t3.xlarge
- "db.t3.2xlarge"
- db.t3.2xlarge
- "db.t2.micro"
- db.t2.micro
- "db.t2.small"
- db.t2.small
- "db.t2.medium"
- db.t2.medium
- "db.t2.large"
- db.t2.large
- "db.t2.xlarge"
- db.t2.xlarge
- "db.t2.2xlarge"
- db.t2.2xlarge
- "db.m1.small"
- db.m1.small
- "db.m1.medium"
- db.m1.medium
- "db.m1.large"
- db.m1.large
- "db.m1.xlarge"
- db.m1.xlarge
- "db.m2.xlarge"
- db.m2.xlarge
- "db.m2.2xlarge"
- db.m2.2xlarge
- "db.m2.4xlarge"
- db.m2.4xlarge
- "db.m3.medium"
- db.m3.medium
- "db.m3.large"
- db.m3.large
- "db.m3.xlarge"
- db.m3.xlarge
- "db.m3.2xlarge"
- db.m3.2xlarge
- "db.m4.large"
- db.m4.large
- "db.m4.xlarge"
- db.m4.xlarge
- "db.m4.2xlarge"
- db.m4.2xlarge
- "db.m4.4xlarge"
- db.m4.4xlarge
- "db.m4.10xlarge"
- db.m4.10xlarge
- "db.m4.10xlarge"
- db.m4.10xlarge
- "db.m5.large"
- db.m5.large
- "db.m5.xlarge"
- db.m5.xlarge
- "db.m5.2xlarge"
- db.m5.2xlarge
- "db.m5.4xlarge"
- db.m5.4xlarge
- "db.m5.12xlarge"
- db.m5.12xlarge
- "db.m5.24xlarge"
- db.m5.24xlarge
- "db.m6g.large"
- db.m6g.large
- "db.m6g.xlarge"
- db.m6g.xlarge
- "db.m6g.2xlarge"
- db.m6g.2xlarge
- "db.m6g.4xlarge"
- db.m6g.4xlarge
- "db.m6g.8xlarge"
- db.m6g.8xlarge
- "db.m6g.12xlarge"
- db.m6g.12xlarge
- "db.m6g.16xlarge"
- db.m6g.16xlarge
- "db.r3.large"
- db.r3.large
- "db.r3.xlarge"
- db.r3.xlarge
- "db.r3.2xlarge"
- db.r3.2xlarge
- "db.r3.4xlarge"
- db.r3.4xlarge
- "db.r3.8xlarge"
- db.r3.8xlarge
- "db.r4.large"
- db.r4.large
- "db.r4.xlarge"
- db.r4.xlarge
- "db.r4.2xlarge"
- db.r4.2xlarge
- "db.r4.4xlarge"
- db.r4.4xlarge
- "db.r4.8xlarge"
- db.r4.8xlarge
- "db.r4.16xlarge"
- db.r4.16xlarge
- "db.r5.large"
- db.r5.large
- "db.r5.xlarge"
- db.r5.xlarge
- "db.r5.2xlarge"
- db.r5.2xlarge
- "db.r5.4xlarge"
- db.r5.4xlarge
- "db.r5.12xlarge"
- db.r5.12xlarge
- "db.r5.24xlarge"
- db.r5.24xlarge
- "db.r6g.large"
- db.r6g.large
- "db.r6g.xlarge"
- db.r6g.xlarge
- "db.r6g.2xlarge"
- db.r6g.2xlarge
- "db.r6g.4xlarge"
- db.r6g.4xlarge
- "db.r6g.8xlarge"
- db.r6g.8xlarge
- "db.r6g.12xlarge"
- db.r6g.12xlarge
- "db.r6g.16xlarge"
- db.r6g.16xlarge
- "db.x1.16xlarge"
- db.x1.16xlarge
- "db.x1.32xlarge"
- db.x1.32xlarge
- "db.x1e.xlarge"
- db.x1e.xlarge
- "db.x1e.2xlarge"
- db.x1e.2xlarge
- "db.x1e.4xlarge"
- db.x1e.4xlarge
- "db.x1e.8xlarge"
- db.x1e.8xlarge
- "db.x1e.32xlarge"
- db.x1e.32xlarge
Import
RDS Cluster Instances can be imported using the identifier
, e.g.,
$ pulumi import aws:rds/clusterInstance:ClusterInstance prod_instance_1 aurora-cluster-instance-1
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.