Module rds

This page documents the language specification for the aws package. If you're looking for help working with the inputs, outputs, or functions of aws resources in a Pulumi program, please see the resource documentation for examples and API reference.

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

namespace InstanceTypes

Others

namespace InstanceTypes

const M1_Large

const M1_Large: InstanceType = "db.m1.large";

const M1_Medium

const M1_Medium: InstanceType = "db.m1.medium";

const M1_Small

const M1_Small: InstanceType = "db.m1.small";

const M1_XLarge

const M1_XLarge: InstanceType = "db.m1.xlarge";

const M2_2XLarge

const M2_2XLarge: InstanceType = "db.m2.2xlarge";

const M2_4XLarge

const M2_4XLarge: InstanceType = "db.m2.4xlarge";

const M2_XLarge

const M2_XLarge: InstanceType = "db.m2.xlarge";

const M3_2XLarge

const M3_2XLarge: InstanceType = "db.m3.2xlarge";

const M3_Large

const M3_Large: InstanceType = "db.m3.large";

const M3_Medium

const M3_Medium: InstanceType = "db.m3.medium";

const M3_XLarge

const M3_XLarge: InstanceType = "db.m3.xlarge";

const M4_10XLarge

const M4_10XLarge: InstanceType = "db.m4.10xlarge";

const M4_16XLarge

const M4_16XLarge: InstanceType = "db.m4.10xlarge";

const M4_2XLarge

const M4_2XLarge: InstanceType = "db.m4.2xlarge";

const M4_4XLarge

const M4_4XLarge: InstanceType = "db.m4.4xlarge";

const M4_Large

const M4_Large: InstanceType = "db.m4.large";

const M4_XLarge

const M4_XLarge: InstanceType = "db.m4.xlarge";

const M5_12XLarge

const M5_12XLarge: InstanceType = "db.m5.12xlarge";

const M5_24XLarge

const M5_24XLarge: InstanceType = "db.m5.24xlarge";

const M5_2XLarge

const M5_2XLarge: InstanceType = "db.m5.2xlarge";

const M5_4XLarge

const M5_4XLarge: InstanceType = "db.m5.4xlarge";

const M5_Large

const M5_Large: InstanceType = "db.m5.large";

const M5_XLarge

const M5_XLarge: InstanceType = "db.m5.xlarge";

const R3_2XLarge

const R3_2XLarge: InstanceType = "db.r3.2xlarge";

const R3_4XLarge

const R3_4XLarge: InstanceType = "db.r3.4xlarge";

const R3_8XLarge

const R3_8XLarge: InstanceType = "db.r3.8xlarge";

const R3_Large

const R3_Large: InstanceType = "db.r3.large";

const R3_XLarge

const R3_XLarge: InstanceType = "db.r3.xlarge";

const R4_16XLarge

const R4_16XLarge: InstanceType = "db.r4.16xlarge";

const R4_2XLarge

const R4_2XLarge: InstanceType = "db.r4.2xlarge";

const R4_4XLarge

const R4_4XLarge: InstanceType = "db.r4.4xlarge";

const R4_8XLarge

const R4_8XLarge: InstanceType = "db.r4.8xlarge";

const R4_Large

const R4_Large: InstanceType = "db.r4.large";

const R4_XLarge

const R4_XLarge: InstanceType = "db.r4.xlarge";

const R5_12XLarge

const R5_12XLarge: InstanceType = "db.r5.12xlarge";

const R5_24XLarge

const R5_24XLarge: InstanceType = "db.r5.24xlarge";

const R5_2XLarge

const R5_2XLarge: InstanceType = "db.r5.2xlarge";

const R5_4XLarge

const R5_4XLarge: InstanceType = "db.r5.4xlarge";

const R5_Large

const R5_Large: InstanceType = "db.r5.large";

const R5_XLarge

const R5_XLarge: InstanceType = "db.r5.xlarge";

const T2_2XLarge

const T2_2XLarge: InstanceType = "db.t2.2xlarge";

const T2_Large

const T2_Large: InstanceType = "db.t2.large";

const T2_Medium

const T2_Medium: InstanceType = "db.t2.medium";

const T2_Micro

const T2_Micro: InstanceType = "db.t2.micro";

const T2_Small

const T2_Small: InstanceType = "db.t2.small";

const T2_XLarge

const T2_XLarge: InstanceType = "db.t2.xlarge";

const T3_2XLarge

const T3_2XLarge: InstanceType = "db.t3.2xlarge";

const T3_Large

const T3_Large: InstanceType = "db.t3.large";

const T3_Medium

const T3_Medium: InstanceType = "db.t3.medium";

const T3_Micro

const T3_Micro: InstanceType = "db.t3.micro";

const T3_Small

const T3_Small: InstanceType = "db.t3.small";

const T3_XLarge

const T3_XLarge: InstanceType = "db.t3.xlarge";

const X1_16XLarge

const X1_16XLarge: InstanceType = "db.x1.16xlarge";

const X1_32XLarge

const X1_32XLarge: InstanceType = "db.x1.32xlarge";

const X1E_2XLarge

const X1E_2XLarge: InstanceType = "db.x1e.2xlarge";

const X1E_32XLarge

const X1E_32XLarge: InstanceType = "db.x1e.32xlarge";

const X1E_4XLarge

const X1E_4XLarge: InstanceType = "db.x1e.4xlarge";

const X1E_8XLarge

const X1E_8XLarge: InstanceType = "db.x1e.8xlarge";

const X1E_XLarge

const X1E_XLarge: InstanceType = "db.x1e.xlarge";

namespace StorageTypes

const GP2

const GP2: StorageType = "gp2";

const Io1

const Io1: StorageType = "io1";

const Standard

const Standard: StorageType = "standard";

Resources

Resource Cluster

class Cluster extends CustomResource

Manages a RDS Aurora Cluster. To manage cluster instances that inherit configuration from the cluster (when not running the cluster in serverless engine mode), see the aws.rds.ClusterInstance resource. To manage non-Aurora databases (e.g. MySQL, PostgreSQL, SQL Server, etc.), see the aws.rds.Instance resource.

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.

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

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

Example Usage

Aurora MySQL 2.x (MySQL 5.7)

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

const defaultCluster = new aws.rds.Cluster("default", {
    availabilityZones: [
        "us-west-2a",
        "us-west-2b",
        "us-west-2c",
    ],
    backupRetentionPeriod: 5,
    clusterIdentifier: "aurora-cluster-demo",
    databaseName: "mydb",
    engine: "aurora-mysql",
    engineVersion: "5.7.mysql_aurora.2.03.2",
    masterPassword: "bar",
    masterUsername: "foo",
    preferredBackupWindow: "07:00-09:00",
});

Aurora MySQL 1.x (MySQL 5.6)

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

const defaultCluster = new aws.rds.Cluster("default", {
    availabilityZones: [
        "us-west-2a",
        "us-west-2b",
        "us-west-2c",
    ],
    backupRetentionPeriod: 5,
    clusterIdentifier: "aurora-cluster-demo",
    databaseName: "mydb",
    masterPassword: "bar",
    masterUsername: "foo",
    preferredBackupWindow: "07:00-09:00",
});

Aurora with PostgreSQL engine

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

const postgresql = new aws.rds.Cluster("postgresql", {
    availabilityZones: [
        "us-west-2a",
        "us-west-2b",
        "us-west-2c",
    ],
    backupRetentionPeriod: 5,
    clusterIdentifier: "aurora-cluster-demo",
    databaseName: "mydb",
    engine: "aurora-postgresql",
    masterPassword: "bar",
    masterUsername: "foo",
    preferredBackupWindow: "07:00-09:00",
});

Aurora Multi-Master Cluster

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

const example = new aws.rds.Cluster("example", {
    clusterIdentifier: "example",
    dbSubnetGroupName: aws_db_subnet_group_example.name,
    engineMode: "multimaster",
    masterPassword: "barbarbarbar",
    masterUsername: "foo",
    skipFinalSnapshot: true,
});

constructor

new Cluster(name: string, args?: ClusterArgs, opts?: pulumi.CustomResourceOptions)

Create a Cluster resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ClusterState, opts?: pulumi.CustomResourceOptions): Cluster

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Cluster

Returns true if the given object is an instance of Cluster. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property applyImmediately

public applyImmediately: pulumi.Output<boolean>;

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

property arn

public arn: pulumi.Output<string>;

Amazon Resource Name (ARN) of cluster

property availabilityZones

public availabilityZones: pulumi.Output<string[]>;

A list of EC2 Availability Zones for the DB cluster storage where DB cluster instances can be created. RDS automatically assigns 3 AZs if less than 3 AZs are configured, which will show as a difference requiring resource recreation next provider update. It is recommended to specify 3 AZs or use the ignoreChanges argument if necessary.

property backtrackWindow

public backtrackWindow: pulumi.Output<number | undefined>;

The target backtrack window, in seconds. Only available for aurora engine currently. To disable backtracking, set this value to 0. Defaults to 0. Must be between 0 and 259200 (72 hours)

property backupRetentionPeriod

public backupRetentionPeriod: pulumi.Output<number | undefined>;

The days to retain backups for. Default 1

property clusterIdentifier

public clusterIdentifier: pulumi.Output<string>;

The cluster identifier. If omitted, this provider will assign a random, unique identifier.

property clusterIdentifierPrefix

public clusterIdentifierPrefix: pulumi.Output<string>;

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

property clusterMembers

public clusterMembers: pulumi.Output<string[]>;

List of RDS Instances that are a part of this cluster

property clusterResourceId

public clusterResourceId: pulumi.Output<string>;

The RDS Cluster Resource ID

property copyTagsToSnapshot

public copyTagsToSnapshot: pulumi.Output<boolean | undefined>;

Copy all Cluster tags to snapshots. Default is false.

property databaseName

public databaseName: pulumi.Output<string>;

Name for an automatically created database on cluster creation. There are different naming restrictions per database engine: RDS Naming Constraints

property dbClusterParameterGroupName

public dbClusterParameterGroupName: pulumi.Output<string>;

A cluster parameter group to associate with the cluster.

property dbSubnetGroupName

public dbSubnetGroupName: pulumi.Output<string>;

A DB subnet group to associate with this DB instance. NOTE: This must match the dbSubnetGroupName specified on every aws.rds.ClusterInstance in the cluster.

property deletionProtection

public deletionProtection: pulumi.Output<boolean | undefined>;

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.

property enableHttpEndpoint

public enableHttpEndpoint: pulumi.Output<boolean | undefined>;

Enable HTTP endpoint (data API). Only valid when engineMode is set to serverless.

property enabledCloudwatchLogsExports

public enabledCloudwatchLogsExports: pulumi.Output<string[] | undefined>;

List of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, error, general, slowquery, postgresql (PostgreSQL).

property endpoint

public endpoint: pulumi.Output<string>;

The DNS address of the RDS instance

property engine

public engine: pulumi.Output<EngineType | undefined>;

The name of the database engine to be used for this DB cluster. Defaults to aurora. Valid Values: aurora, aurora-mysql, aurora-postgresql

property engineMode

public engineMode: pulumi.Output<EngineMode | undefined>;

The database engine mode. Valid values: global, multimaster, parallelquery, provisioned, serverless. Defaults to: provisioned. See the RDS User Guide for limitations when using serverless.

property engineVersion

public engineVersion: pulumi.Output<string>;

The database engine version. Updating this argument results in an outage. See the Aurora MySQL and Aurora Postgres documentation for your configured engine to determine this value. For example with Aurora MySQL 2, a potential value for this argument is 5.7.mysql_aurora.2.03.2.

property finalSnapshotIdentifier

public finalSnapshotIdentifier: pulumi.Output<string | undefined>;

The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.

property globalClusterIdentifier

public globalClusterIdentifier: pulumi.Output<string | undefined>;

The global cluster identifier specified on aws.rds.GlobalCluster.

property hostedZoneId

public hostedZoneId: pulumi.Output<string>;

The Route53 Hosted Zone ID of the endpoint

property iamDatabaseAuthenticationEnabled

public iamDatabaseAuthenticationEnabled: pulumi.Output<boolean | undefined>;

Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Please see AWS Documentation for availability and limitations.

property iamRoles

public iamRoles: pulumi.Output<string[] | undefined>;

A List of ARNs for the IAM roles to associate to the RDS Cluster.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kmsKeyId

public kmsKeyId: pulumi.Output<string>;

The ARN for the KMS encryption key. When specifying kmsKeyId, storageEncrypted needs to be set to true.

property masterPassword

public masterPassword: pulumi.Output<string | undefined>;

Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the RDS Naming Constraints

property masterUsername

public masterUsername: pulumi.Output<string>;

Username for the master DB user. Please refer to the RDS Naming Constraints. This argument does not support in-place updates and cannot be changed during a restore from snapshot.

property port

public port: pulumi.Output<number>;

The port on which the DB accepts connections

property preferredBackupWindow

public preferredBackupWindow: pulumi.Output<string>;

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC. Default: A 30-minute window selected at random from an 8-hour block of time per region. e.g. 04:00-09:00

property preferredMaintenanceWindow

public preferredMaintenanceWindow: pulumi.Output<string>;

The weekly time range during which system maintenance can occur, in (UTC) e.g. wed:04:00-wed:04:30

property readerEndpoint

public readerEndpoint: pulumi.Output<string>;

A read-only endpoint for the Aurora cluster, automatically load-balanced across replicas

property replicationSourceIdentifier

public replicationSourceIdentifier: pulumi.Output<string | undefined>;

ARN of a source DB cluster or DB instance if this DB cluster is to be created as a Read Replica.

property s3Import

public s3Import: pulumi.Output<ClusterS3Import | undefined>;

property scalingConfiguration

public scalingConfiguration: pulumi.Output<ClusterScalingConfiguration | undefined>;

Nested attribute with scaling properties. Only valid when engineMode is set to serverless. More details below.

property skipFinalSnapshot

public skipFinalSnapshot: pulumi.Output<boolean | undefined>;

Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from finalSnapshotIdentifier. Default is false.

property snapshotIdentifier

public snapshotIdentifier: pulumi.Output<string | undefined>;

Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot.

property sourceRegion

public sourceRegion: pulumi.Output<string | undefined>;

The source region for an encrypted replica DB cluster.

property storageEncrypted

public storageEncrypted: pulumi.Output<boolean | undefined>;

Specifies whether the DB cluster is encrypted. The default is false for provisioned engineMode and true for serverless engineMode.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A map of tags to assign to the DB cluster.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vpcSecurityGroupIds

public vpcSecurityGroupIds: pulumi.Output<string[]>;

List of VPC security groups to associate with the Cluster

Resource ClusterEndpoint

class ClusterEndpoint extends CustomResource

Manages an RDS Aurora Cluster Endpoint. You can refer to the User Guide.

Example Usage

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

const defaultCluster = new aws.rds.Cluster("default", {
    availabilityZones: [
        "us-west-2a",
        "us-west-2b",
        "us-west-2c",
    ],
    backupRetentionPeriod: 5,
    clusterIdentifier: "aurora-cluster-demo",
    databaseName: "mydb",
    masterPassword: "bar",
    masterUsername: "foo",
    preferredBackupWindow: "07:00-09:00",
});
const test1 = new aws.rds.ClusterInstance("test1", {
    applyImmediately: true,
    clusterIdentifier: defaultCluster.id,
    identifier: "test1",
    instanceClass: "db.t2.small",
});
const test2 = new aws.rds.ClusterInstance("test2", {
    applyImmediately: true,
    clusterIdentifier: defaultCluster.id,
    identifier: "test2",
    instanceClass: "db.t2.small",
});
const test3 = new aws.rds.ClusterInstance("test3", {
    applyImmediately: true,
    clusterIdentifier: defaultCluster.id,
    identifier: "test3",
    instanceClass: "db.t2.small",
});
const eligible = new aws.rds.ClusterEndpoint("eligible", {
    clusterEndpointIdentifier: "reader",
    clusterIdentifier: defaultCluster.id,
    customEndpointType: "READER",
    excludedMembers: [
        test1.id,
        test2.id,
    ],
});
const static = new aws.rds.ClusterEndpoint("static", {
    clusterEndpointIdentifier: "static",
    clusterIdentifier: defaultCluster.id,
    customEndpointType: "READER",
    staticMembers: [
        test1.id,
        test3.id,
    ],
});

constructor

new ClusterEndpoint(name: string, args: ClusterEndpointArgs, opts?: pulumi.CustomResourceOptions)

Create a ClusterEndpoint resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ClusterEndpointState, opts?: pulumi.CustomResourceOptions): ClusterEndpoint

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ClusterEndpoint

Returns true if the given object is an instance of ClusterEndpoint. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

Amazon Resource Name (ARN) of cluster

property clusterEndpointIdentifier

public clusterEndpointIdentifier: pulumi.Output<string>;

The identifier to use for the new endpoint. This parameter is stored as a lowercase string.

property clusterIdentifier

public clusterIdentifier: pulumi.Output<string>;

The cluster identifier.

property customEndpointType

public customEndpointType: pulumi.Output<string>;

The type of the endpoint. One of: READER , ANY .

property endpoint

public endpoint: pulumi.Output<string>;

A custom endpoint for the Aurora cluster

property excludedMembers

public excludedMembers: pulumi.Output<string[] | undefined>;

List of DB instance identifiers that aren’t part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty. Conflicts with staticMembers.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property staticMembers

public staticMembers: pulumi.Output<string[] | undefined>;

List of DB instance identifiers that are part of the custom endpoint group. Conflicts with excludedMembers.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

Key-value map of resource tags

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ClusterInstance

class ClusterInstance extends CustomResource

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 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 instanceClass 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

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

const defaultCluster = new aws.rds.Cluster("default", {
    availabilityZones: [
        "us-west-2a",
        "us-west-2b",
        "us-west-2c",
    ],
    clusterIdentifier: "aurora-cluster-demo",
    databaseName: "mydb",
    masterPassword: "barbut8chars",
    masterUsername: "foo",
});
const clusterInstances: aws.rds.ClusterInstance[] = [];
for (let i = 0; i < 2; i++) {
    clusterInstances.push(new aws.rds.ClusterInstance(`cluster_instances-${i}`, {
        clusterIdentifier: defaultCluster.id,
        identifier: `aurora-cluster-demo-${i}`,
        instanceClass: "db.r4.large",
    }));
}

constructor

new ClusterInstance(name: string, args: ClusterInstanceArgs, opts?: pulumi.CustomResourceOptions)

Create a ClusterInstance resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ClusterInstanceState, opts?: pulumi.CustomResourceOptions): ClusterInstance

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ClusterInstance

Returns true if the given object is an instance of ClusterInstance. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property applyImmediately

public applyImmediately: pulumi.Output<boolean>;

Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default isfalse.

property arn

public arn: pulumi.Output<string>;

Amazon Resource Name (ARN) of cluster instance

property autoMinorVersionUpgrade

public autoMinorVersionUpgrade: pulumi.Output<boolean | undefined>;

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

property availabilityZone

public availabilityZone: pulumi.Output<string>;

The EC2 Availability Zone that the DB instance is created in. See docs about the details.

property caCertIdentifier

public caCertIdentifier: pulumi.Output<string>;

The identifier of the CA certificate for the DB instance.

property clusterIdentifier

public clusterIdentifier: pulumi.Output<string>;

The identifier of the aws.rds.Cluster in which to launch this instance.

property copyTagsToSnapshot

public copyTagsToSnapshot: pulumi.Output<boolean | undefined>;

Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance. Default false.

property dbParameterGroupName

public dbParameterGroupName: pulumi.Output<string>;

The name of the DB parameter group to associate with this instance.

property dbSubnetGroupName

public dbSubnetGroupName: pulumi.Output<string>;

A DB subnet group to associate with this DB instance. NOTE: This must match the dbSubnetGroupName of the attached aws.rds.Cluster.

property dbiResourceId

public dbiResourceId: pulumi.Output<string>;

The region-unique, immutable identifier for the DB instance.

property endpoint

public endpoint: pulumi.Output<string>;

The DNS address for this instance. May not be writable

property engine

public engine: pulumi.Output<EngineType | undefined>;

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.

property engineVersion

public engineVersion: pulumi.Output<string>;

The database engine version.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property identifier

public identifier: pulumi.Output<string>;

The indentifier for the RDS instance, if omitted, this provider will assign a random, unique identifier.

property identifierPrefix

public identifierPrefix: pulumi.Output<string>;

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

property instanceClass

public instanceClass: pulumi.Output<string>;

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.

property kmsKeyId

public kmsKeyId: pulumi.Output<string>;

The ARN for the KMS encryption key if one is set to the cluster.

property monitoringInterval

public monitoringInterval: pulumi.Output<number | undefined>;

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.

property monitoringRoleArn

public monitoringRoleArn: pulumi.Output<string>;

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.

property performanceInsightsEnabled

public performanceInsightsEnabled: pulumi.Output<boolean>;

Specifies whether Performance Insights is enabled or not.

property performanceInsightsKmsKeyId

public performanceInsightsKmsKeyId: pulumi.Output<string>;

The ARN for the KMS key to encrypt Performance Insights data. When specifying performanceInsightsKmsKeyId, performanceInsightsEnabled needs to be set to true.

property port

public port: pulumi.Output<number>;

The database port

property preferredBackupWindow

public preferredBackupWindow: pulumi.Output<string>;

The daily time range during which automated backups are created if automated backups are enabled. Eg: “04:00-09:00”

property preferredMaintenanceWindow

public preferredMaintenanceWindow: pulumi.Output<string>;

The window to perform maintenance in. Syntax: “ddd:hh24:mi-ddd:hh24:mi”. Eg: “Mon:00:00-Mon:03:00”.

property promotionTier

public promotionTier: pulumi.Output<number | undefined>;

Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoted to writer.

property publiclyAccessible

public publiclyAccessible: pulumi.Output<boolean | undefined>;

Bool to control if instance is publicly accessible. Default false. See the documentation on Creating DB Instances for more details on controlling this property.

property storageEncrypted

public storageEncrypted: pulumi.Output<boolean>;

Specifies whether the DB cluster is encrypted.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A map of tags to assign to the instance.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property writer

public writer: pulumi.Output<boolean>;

Boolean indicating if this instance is writable. False indicates this instance is a read replica.

Resource ClusterParameterGroup

class ClusterParameterGroup extends CustomResource

Provides an RDS DB cluster parameter group resource. Documentation of the available parameters for various Aurora engines can be found at:

Example Usage

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

const defaultClusterParameterGroup = new aws.rds.ClusterParameterGroup("default", {
    description: "RDS default cluster parameter group",
    family: "aurora5.6",
    parameters: [
        {
            name: "character_set_server",
            value: "utf8",
        },
        {
            name: "character_set_client",
            value: "utf8",
        },
    ],
});

constructor

new ClusterParameterGroup(name: string, args: ClusterParameterGroupArgs, opts?: pulumi.CustomResourceOptions)

Create a ClusterParameterGroup resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ClusterParameterGroupState, opts?: pulumi.CustomResourceOptions): ClusterParameterGroup

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ClusterParameterGroup

Returns true if the given object is an instance of ClusterParameterGroup. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The ARN of the db cluster parameter group.

property description

public description: pulumi.Output<string>;

The description of the DB cluster parameter group. Defaults to “Managed by Pulumi”.

property family

public family: pulumi.Output<string>;

The family of the DB cluster parameter group.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the DB parameter.

property namePrefix

public namePrefix: pulumi.Output<string>;

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

property parameters

public parameters: pulumi.Output<ClusterParameterGroupParameter[] | undefined>;

A list of DB parameters to apply. Note that parameters may differ from a family to an other. Full list of all parameters can be discovered via aws rds describe-db-cluster-parameters after initial creation of the group.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A map of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ClusterSnapshot

class ClusterSnapshot extends CustomResource

Manages an RDS database cluster snapshot for Aurora clusters. For managing RDS database instance snapshots, see the aws.rds.Snapshot resource.

Example Usage

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

const example = new aws.rds.ClusterSnapshot("example", {
    dbClusterIdentifier: aws_rds_cluster_example.id,
    dbClusterSnapshotIdentifier: "resourcetestsnapshot1234",
});

constructor

new ClusterSnapshot(name: string, args: ClusterSnapshotArgs, opts?: pulumi.CustomResourceOptions)

Create a ClusterSnapshot resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ClusterSnapshotState, opts?: pulumi.CustomResourceOptions): ClusterSnapshot

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ClusterSnapshot

Returns true if the given object is an instance of ClusterSnapshot. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property allocatedStorage

public allocatedStorage: pulumi.Output<number>;

Specifies the allocated storage size in gigabytes (GB).

property availabilityZones

public availabilityZones: pulumi.Output<string[]>;

List of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.

property dbClusterIdentifier

public dbClusterIdentifier: pulumi.Output<string>;

The DB Cluster Identifier from which to take the snapshot.

property dbClusterSnapshotArn

public dbClusterSnapshotArn: pulumi.Output<string>;

The Amazon Resource Name (ARN) for the DB Cluster Snapshot.

property dbClusterSnapshotIdentifier

public dbClusterSnapshotIdentifier: pulumi.Output<string>;

The Identifier for the snapshot.

property engine

public engine: pulumi.Output<string>;

Specifies the name of the database engine.

property engineVersion

public engineVersion: pulumi.Output<string>;

Version of the database engine for this DB cluster snapshot.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kmsKeyId

public kmsKeyId: pulumi.Output<string>;

If storageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.

property licenseModel

public licenseModel: pulumi.Output<string>;

License model information for the restored DB cluster.

property port

public port: pulumi.Output<number>;

Port that the DB cluster was listening on at the time of the snapshot.

property snapshotType

public snapshotType: pulumi.Output<string>;

property sourceDbClusterSnapshotArn

public sourceDbClusterSnapshotArn: pulumi.Output<string>;

property status

public status: pulumi.Output<string>;

The status of this DB Cluster Snapshot.

property storageEncrypted

public storageEncrypted: pulumi.Output<boolean>;

Specifies whether the DB cluster snapshot is encrypted.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A map of tags to assign to the DB cluster.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vpcId

public vpcId: pulumi.Output<string>;

The VPC ID associated with the DB cluster snapshot.

Resource EventSubscription

class EventSubscription extends CustomResource

Provides a DB event subscription resource.

Example Usage

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

const defaultInstance = new aws.rds.Instance("default", {
    allocatedStorage: 10,
    dbSubnetGroupName: "my_database_subnet_group",
    engine: "mysql",
    engineVersion: "5.6.17",
    instanceClass: "db.t2.micro",
    name: "mydb",
    parameterGroupName: "default.mysql5.6",
    password: "bar",
    username: "foo",
});
const defaultTopic = new aws.sns.Topic("default", {});
const defaultEventSubscription = new aws.rds.EventSubscription("default", {
    eventCategories: [
        "availability",
        "deletion",
        "failover",
        "failure",
        "low storage",
        "maintenance",
        "notification",
        "read replica",
        "recovery",
        "restoration",
    ],
    snsTopic: defaultTopic.arn,
    sourceIds: [defaultInstance.id],
    sourceType: "db-instance",
});

Attributes

The following additional atttributes are provided:

id - The name of the RDS event notification subscription
arn - The Amazon Resource Name of the RDS event notification subscription
customerAwsId - The AWS customer account associated with the RDS event notification subscription

constructor

new EventSubscription(name: string, args: EventSubscriptionArgs, opts?: pulumi.CustomResourceOptions)

Create a EventSubscription resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: EventSubscriptionState, opts?: pulumi.CustomResourceOptions): EventSubscription

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is EventSubscription

Returns true if the given object is an instance of EventSubscription. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

property customerAwsId

public customerAwsId: pulumi.Output<string>;

property enabled

public enabled: pulumi.Output<boolean | undefined>;

A boolean flag to enable/disable the subscription. Defaults to true.

property eventCategories

public eventCategories: pulumi.Output<string[] | undefined>;

A list of event categories for a SourceType that you want to subscribe to. See http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html or run aws rds describe-event-categories.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the DB event subscription. By default generated by this provider.

property namePrefix

public namePrefix: pulumi.Output<string | undefined>;

The name of the DB event subscription. Conflicts with name.

property snsTopic

public snsTopic: pulumi.Output<string>;

The SNS topic to send events to.

property sourceIds

public sourceIds: pulumi.Output<string[] | undefined>;

A list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. If specified, a sourceType must also be specified.

property sourceType

public sourceType: pulumi.Output<string | undefined>;

The type of source that will be generating the events. Valid options are db-instance, db-security-group, db-parameter-group, db-snapshot, db-cluster or db-cluster-snapshot. If not set, all sources will be subscribed to.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A map of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource GlobalCluster

class GlobalCluster extends CustomResource

Manages an RDS Global Cluster, which is an Aurora global database spread across multiple regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem.

More information about Aurora global databases can be found in the Aurora User Guide.

Example Usage

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

const primary = new aws.Provider("primary", {
    region: "us-east-2",
});
const secondary = new aws.Provider("secondary", {
    region: "us-west-2",
});
const example = new aws.rds.GlobalCluster("example", {
    globalClusterIdentifier: "example",
}, { provider: primary });
const primaryCluster = new aws.rds.Cluster("primary", {
    // ... other configuration ...
    engineMode: "global",
    globalClusterIdentifier: example.id,
}, { provider: primary });
const primaryClusterInstance = new aws.rds.ClusterInstance("primary", {
    // ... other configuration ...
    clusterIdentifier: primaryCluster.id,
}, { provider: primary });
const secondaryCluster = new aws.rds.Cluster("secondary", {
    // ... other configuration ...
    engineMode: "global",
    globalClusterIdentifier: example.id,
}, { provider: secondary, dependsOn: [primaryClusterInstance] });
const secondaryClusterInstance = new aws.rds.ClusterInstance("secondary", {
    // ... other configuration ...
    clusterIdentifier: secondaryCluster.id,
}, { provider: secondary });

constructor

new GlobalCluster(name: string, args: GlobalClusterArgs, opts?: pulumi.CustomResourceOptions)

Create a GlobalCluster resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: GlobalClusterState, opts?: pulumi.CustomResourceOptions): GlobalCluster

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is GlobalCluster

Returns true if the given object is an instance of GlobalCluster. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

RDS Global Cluster Amazon Resource Name (ARN)

property databaseName

public databaseName: pulumi.Output<string | undefined>;

Name for an automatically created database on cluster creation.

property deletionProtection

public deletionProtection: pulumi.Output<boolean | undefined>;

If the Global Cluster should have deletion protection enabled. The database can’t be deleted when this value is set to true. The default is false.

property engine

public engine: pulumi.Output<string | undefined>;

Name of the database engine to be used for this DB cluster. Valid values: aurora, aurora-mysql, aurora-postgresql. Defaults to aurora.

property engineVersion

public engineVersion: pulumi.Output<string>;

Engine version of the Aurora global database. * NOTE: When the engine is set to aurora-mysql, an engine version compatible with global database is required. The earliest available version is 5.7.mysql_aurora.2.06.0.

property globalClusterIdentifier

public globalClusterIdentifier: pulumi.Output<string>;

The global cluster identifier.

property globalClusterResourceId

public globalClusterResourceId: pulumi.Output<string>;

AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property storageEncrypted

public storageEncrypted: pulumi.Output<boolean | undefined>;

Specifies whether the DB cluster is encrypted. The default is false.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Instance

class Instance extends CustomResource

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

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

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

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

RDS Instance Class Types

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

Example Usage

Basic Usage

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

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

Storage Autoscaling

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

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

constructor

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

Create a Instance resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

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

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Instance

Returns true if the given object is an instance of Instance. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property address

public address: pulumi.Output<string>;

The hostname of the RDS instance. See also endpoint and port.

property allocatedStorage

public allocatedStorage: pulumi.Output<number>;

The allocated storage in gibibytes. If maxAllocatedStorage is configured, this argument represents the initial storage allocation and differences from the configuration will be ignored automatically when Storage Autoscaling occurs.

property allowMajorVersionUpgrade

public allowMajorVersionUpgrade: pulumi.Output<boolean | undefined>;

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.

property applyImmediately

public applyImmediately: pulumi.Output<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.

property arn

public arn: pulumi.Output<string>;

The ARN of the RDS instance.

property autoMinorVersionUpgrade

public autoMinorVersionUpgrade: pulumi.Output<boolean | undefined>;

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

property availabilityZone

public availabilityZone: pulumi.Output<string>;

The AZ for the RDS instance.

property backupRetentionPeriod

public backupRetentionPeriod: pulumi.Output<number>;

The days to retain backups for. Must be between 0 and 35. Must be greater than 0 if the database is used as a source for a Read Replica. [See Read Replica][1].

property backupWindow

public backupWindow: pulumi.Output<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 maintenanceWindow.

property caCertIdentifier

public caCertIdentifier: pulumi.Output<string>;

The identifier of the CA certificate for the DB instance.

property characterSetName

public characterSetName: pulumi.Output<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.

property copyTagsToSnapshot

public copyTagsToSnapshot: pulumi.Output<boolean | undefined>;

Copy all Instance tags to snapshots. Default is false.

property dbSubnetGroupName

public dbSubnetGroupName: pulumi.Output<string>;

Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC, or in EC2 Classic, if available. When working with read replicas, it should be specified only if the source database specifies an instance in another AWS Region. See DBSubnetGroupName in API action CreateDBInstanceReadReplica for additional read replica contraints.

property deleteAutomatedBackups

public deleteAutomatedBackups: pulumi.Output<boolean | undefined>;

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

property deletionProtection

public deletionProtection: pulumi.Output<boolean | undefined>;

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.

property domain

public domain: pulumi.Output<string | undefined>;

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

property domainIamRoleName

public domainIamRoleName: pulumi.Output<string | undefined>;

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

property enabledCloudwatchLogsExports

public enabledCloudwatchLogsExports: pulumi.Output<string[] | undefined>;

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

property endpoint

public endpoint: pulumi.Output<string>;

The connection endpoint in address:port format.

property engine

public engine: pulumi.Output<string>;

(Required unless a snapshotIdentifier or replicateSourceDb is provided) The database engine to use. For supported values, see the Engine parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine must match the DB cluster’s engine’. For information on the difference between the available Aurora MySQL engines see Comparison between Aurora MySQL 1 and Aurora MySQL 2 in the Amazon RDS User Guide.

property engineVersion

public engineVersion: pulumi.Output<string>;

The engine version to use. If autoMinorVersionUpgrade is enabled, you can provide a prefix of the version such as 5.7 (for 5.7.10) and this attribute will ignore differences in the patch version automatically (e.g. 5.7.17). For supported values, see the EngineVersion parameter in API action CreateDBInstance. Note that for Amazon Aurora instances the engine version must match the DB cluster’s engine version’.

property finalSnapshotIdentifier

public finalSnapshotIdentifier: pulumi.Output<string | undefined>;

The name of your final DB snapshot when this DB instance is deleted. Must be provided if skipFinalSnapshot is set to false.

property hostedZoneId

public hostedZoneId: pulumi.Output<string>;

The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record).

property iamDatabaseAuthenticationEnabled

public iamDatabaseAuthenticationEnabled: pulumi.Output<boolean | undefined>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property identifier

public identifier: pulumi.Output<string>;

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

property identifierPrefix

public identifierPrefix: pulumi.Output<string>;

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

property instanceClass

public instanceClass: pulumi.Output<string>;

The instance type of the RDS instance.

property iops

public iops: pulumi.Output<number | undefined>;

The amount of provisioned IOPS. Setting this implies a storageType of “io1”.

property kmsKeyId

public kmsKeyId: pulumi.Output<string>;

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

property licenseModel

public licenseModel: pulumi.Output<string>;

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

property maintenanceWindow

public maintenanceWindow: pulumi.Output<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.

property maxAllocatedStorage

public maxAllocatedStorage: pulumi.Output<number | undefined>;

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 allocatedStorage. Must be greater than or equal to allocatedStorage or 0 to disable Storage Autoscaling.

property monitoringInterval

public monitoringInterval: pulumi.Output<number | undefined>;

property monitoringRoleArn

public monitoringRoleArn: pulumi.Output<string>;

property multiAz

public multiAz: pulumi.Output<boolean>;

Specifies if the RDS instance is multi-AZ

property name

public name: pulumi.Output<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.

property optionGroupName

public optionGroupName: pulumi.Output<string>;

Name of the DB option group to associate.

property parameterGroupName

public parameterGroupName: pulumi.Output<string>;

Name of the DB parameter group to associate.

property password

public password: pulumi.Output<string | undefined>;

(Required unless a snapshotIdentifier or replicateSourceDb is provided) Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file.

property performanceInsightsEnabled

public performanceInsightsEnabled: pulumi.Output<boolean | undefined>;

Specifies whether Performance Insights are enabled. Defaults to false.

property performanceInsightsKmsKeyId

public performanceInsightsKmsKeyId: pulumi.Output<string>;

The ARN for the KMS key to encrypt Performance Insights data. When specifying performanceInsightsKmsKeyId, performanceInsightsEnabled needs to be set to true. Once KMS key is set, it can never be changed.

property performanceInsightsRetentionPeriod

public performanceInsightsRetentionPeriod: pulumi.Output<number>;

The amount of time in days to retain Performance Insights data. Either 7 (7 days) or 731 (2 years). When specifying performanceInsightsRetentionPeriod, performanceInsightsEnabled needs to be set to true. Defaults to ‘7’.

property port

public port: pulumi.Output<number>;

The port on which the DB accepts connections.

property publiclyAccessible

public publiclyAccessible: pulumi.Output<boolean | undefined>;

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

property replicas

public replicas: pulumi.Output<string[]>;

property replicateSourceDb

public replicateSourceDb: pulumi.Output<string | undefined>;

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 kmsKeyId. See [DB Instance Replication][1] and Working with PostgreSQL and MySQL Read Replicas for more information on using Replication.

property resourceId

public resourceId: pulumi.Output<string>;

The RDS Resource ID of this instance.

property s3Import

public s3Import: pulumi.Output<InstanceS3Import | undefined>;

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

property securityGroupNames

public securityGroupNames: pulumi.Output<string[] | undefined>;

List of DB Security Groups to associate. Only used for DB Instances on the EC2-Classic Platform.

property skipFinalSnapshot

public skipFinalSnapshot: pulumi.Output<boolean | undefined>;

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 finalSnapshotIdentifier. Default is false.

property snapshotIdentifier

public snapshotIdentifier: pulumi.Output<string | undefined>;

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.

property status

public status: pulumi.Output<string>;

The RDS instance status.

property storageEncrypted

public storageEncrypted: pulumi.Output<boolean | undefined>;

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 kmsKeyId with a valid ARN. The default is false if not specified.

property storageType

public storageType: pulumi.Output<string>;

One of “standard” (magnetic), “gp2” (general purpose SSD), or “io1” (provisioned IOPS SSD). The default is “io1” if iops is specified, “gp2” if not.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A map of tags to assign to the resource.

property timezone

public timezone: pulumi.Output<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.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property username

public username: pulumi.Output<string>;

(Required unless a snapshotIdentifier or replicateSourceDb is provided) Username for the master DB user.

property vpcSecurityGroupIds

public vpcSecurityGroupIds: pulumi.Output<string[]>;

List of VPC security groups to associate.

Resource OptionGroup

class OptionGroup extends CustomResource

Provides an RDS DB option group resource. Documentation of the available options for various RDS engines can be found at:

Example Usage

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

const example = new aws.rds.OptionGroup("example", {
    engineName: "sqlserver-ee",
    majorEngineVersion: "11.00",
    options: [
        {
            optionName: "Timezone",
            optionSettings: [{
                name: "TIME_ZONE",
                value: "UTC",
            }],
        },
        {
            optionName: "SQLSERVER_BACKUP_RESTORE",
            optionSettings: [{
                name: "IAM_ROLE_ARN",
                value: aws_iam_role_example.arn,
            }],
        },
        {
            optionName: "TDE",
        },
    ],
    optionGroupDescription: "Option Group",
});

constructor

new OptionGroup(name: string, args: OptionGroupArgs, opts?: pulumi.CustomResourceOptions)

Create a OptionGroup resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: OptionGroupState, opts?: pulumi.CustomResourceOptions): OptionGroup

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is OptionGroup

Returns true if the given object is an instance of OptionGroup. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The ARN of the db option group.

property engineName

public engineName: pulumi.Output<string>;

Specifies the name of the engine that this option group should be associated with.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property majorEngineVersion

public majorEngineVersion: pulumi.Output<string>;

Specifies the major version of the engine that this option group should be associated with.

property name

public name: pulumi.Output<string>;

The Name of the setting.

property namePrefix

public namePrefix: pulumi.Output<string>;

Creates a unique name beginning with the specified prefix. Conflicts with name. Must be lowercase, to match as it is stored in AWS.

property optionGroupDescription

public optionGroupDescription: pulumi.Output<string>;

The description of the option group. Defaults to “Managed by Pulumi”.

property options

public options: pulumi.Output<OptionGroupOption[] | undefined>;

A list of Options to apply.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A map of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ParameterGroup

class ParameterGroup extends CustomResource

Provides an RDS DB parameter group resource .Documentation of the available parameters for various RDS engines can be found at:

Example Usage

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

const defaultParameterGroup = new aws.rds.ParameterGroup("default", {
    family: "mysql5.6",
    parameters: [
        {
            name: "character_set_server",
            value: "utf8",
        },
        {
            name: "character_set_client",
            value: "utf8",
        },
    ],
});

constructor

new ParameterGroup(name: string, args: ParameterGroupArgs, opts?: pulumi.CustomResourceOptions)

Create a ParameterGroup resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ParameterGroupState, opts?: pulumi.CustomResourceOptions): ParameterGroup

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ParameterGroup

Returns true if the given object is an instance of ParameterGroup. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The ARN of the db parameter group.

property description

public description: pulumi.Output<string>;

The description of the DB parameter group. Defaults to “Managed by Pulumi”.

property family

public family: pulumi.Output<string>;

The family of the DB parameter group.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the DB parameter.

property namePrefix

public namePrefix: pulumi.Output<string>;

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

property parameters

public parameters: pulumi.Output<ParameterGroupParameter[] | undefined>;

A list of DB parameters to apply. Note that parameters may differ from a family to an other. Full list of all parameters can be discovered via aws rds describe-db-parameters after initial creation of the group.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A map of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource RoleAssociation

class RoleAssociation extends CustomResource

Manages an RDS DB Instance association with an IAM Role. Example use cases:

To manage the RDS DB Instance IAM Role for Enhanced Monitoring, see the aws.rds.Instance resource monitoringRoleArn argument instead.

Example Usage

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

const example = new aws.rds.RoleAssociation("example", {
    dbInstanceIdentifier: aws_db_instance_example.id,
    featureName: "S3_INTEGRATION",
    roleArn: aws_iam_role_example.id,
});

constructor

new RoleAssociation(name: string, args: RoleAssociationArgs, opts?: pulumi.CustomResourceOptions)

Create a RoleAssociation resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RoleAssociationState, opts?: pulumi.CustomResourceOptions): RoleAssociation

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is RoleAssociation

Returns true if the given object is an instance of RoleAssociation. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property dbInstanceIdentifier

public dbInstanceIdentifier: pulumi.Output<string>;

DB Instance Identifier to associate with the IAM Role.

property featureName

public featureName: pulumi.Output<string>;

Name of the feature for association. This can be found in the AWS documentation relevant to the integration or a full list is available in the SupportedFeatureNames list returned by AWS CLI rds describe-db-engine-versions.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property roleArn

public roleArn: pulumi.Output<string>;

Amazon Resource Name (ARN) of the IAM Role to associate with the DB Instance.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource SecurityGroup

class SecurityGroup extends CustomResource

Provides an RDS security group resource. This is only for DB instances in the EC2-Classic Platform. For instances inside a VPC, use the aws_db_instance.vpc_security_group_ids attribute instead.

Example Usage

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

const defaultSecurityGroup = new aws.rds.SecurityGroup("default", {
    ingress: [{
        cidr: "10.0.0.0/24",
    }],
});

constructor

new SecurityGroup(name: string, args: SecurityGroupArgs, opts?: pulumi.CustomResourceOptions)

Create a SecurityGroup resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SecurityGroupState, opts?: pulumi.CustomResourceOptions): SecurityGroup

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is SecurityGroup

Returns true if the given object is an instance of SecurityGroup. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The arn of the DB security group.

property description

public description: pulumi.Output<string>;

The description of the DB security group. Defaults to “Managed by Pulumi”.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property ingress

public ingress: pulumi.Output<SecurityGroupIngress[]>;

A list of ingress rules.

property name

public name: pulumi.Output<string>;

The name of the DB security group.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A map of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Snapshot

class Snapshot extends CustomResource

Manages an RDS database instance snapshot. For managing RDS database cluster snapshots, see the aws.rds.ClusterSnapshot resource.

Example Usage

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

const bar = new aws.rds.Instance("bar", {
    allocatedStorage: 10,
    backupRetentionPeriod: 0,
    engine: "MySQL",
    engineVersion: "5.6.21",
    instanceClass: "db.t2.micro",
    maintenanceWindow: "Fri:09:00-Fri:09:30",
    name: "baz",
    parameterGroupName: "default.mysql5.6",
    password: "barbarbarbar",
    username: "foo",
});
const test = new aws.rds.Snapshot("test", {
    dbInstanceIdentifier: bar.id,
    dbSnapshotIdentifier: "testsnapshot1234",
});

constructor

new Snapshot(name: string, args: SnapshotArgs, opts?: pulumi.CustomResourceOptions)

Create a Snapshot resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SnapshotState, opts?: pulumi.CustomResourceOptions): Snapshot

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Snapshot

Returns true if the given object is an instance of Snapshot. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property allocatedStorage

public allocatedStorage: pulumi.Output<number>;

Specifies the allocated storage size in gigabytes (GB).

property availabilityZone

public availabilityZone: pulumi.Output<string>;

Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

property dbInstanceIdentifier

public dbInstanceIdentifier: pulumi.Output<string>;

The DB Instance Identifier from which to take the snapshot.

property dbSnapshotArn

public dbSnapshotArn: pulumi.Output<string>;

The Amazon Resource Name (ARN) for the DB snapshot.

property dbSnapshotIdentifier

public dbSnapshotIdentifier: pulumi.Output<string>;

The Identifier for the snapshot.

property encrypted

public encrypted: pulumi.Output<boolean>;

Specifies whether the DB snapshot is encrypted.

property engine

public engine: pulumi.Output<string>;

Specifies the name of the database engine.

property engineVersion

public engineVersion: pulumi.Output<string>;

Specifies the version of the database engine.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property iops

public iops: pulumi.Output<number>;

Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

property kmsKeyId

public kmsKeyId: pulumi.Output<string>;

The ARN for the KMS encryption key.

property licenseModel

public licenseModel: pulumi.Output<string>;

License model information for the restored DB instance.

property optionGroupName

public optionGroupName: pulumi.Output<string>;

Provides the option group name for the DB snapshot.

property port

public port: pulumi.Output<number>;

property snapshotType

public snapshotType: pulumi.Output<string>;

property sourceDbSnapshotIdentifier

public sourceDbSnapshotIdentifier: pulumi.Output<string>;

The DB snapshot Arn that the DB snapshot was copied from. It only has value in case of cross customer or cross region copy.

property sourceRegion

public sourceRegion: pulumi.Output<string>;

The region that the DB snapshot was created in or copied from.

property status

public status: pulumi.Output<string>;

Specifies the status of this DB snapshot.

property storageType

public storageType: pulumi.Output<string>;

Specifies the storage type associated with DB snapshot.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

Key-value map of resource tags

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vpcId

public vpcId: pulumi.Output<string>;

Specifies the storage type associated with DB snapshot.

Resource SubnetGroup

class SubnetGroup extends CustomResource

Provides an RDS DB subnet group resource.

Example Usage

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

const defaultSubnetGroup = new aws.rds.SubnetGroup("default", {
    subnetIds: [
        aws_subnet_frontend.id,
        aws_subnet_backend.id,
    ],
    tags: {
        Name: "My DB subnet group",
    },
});

constructor

new SubnetGroup(name: string, args: SubnetGroupArgs, opts?: pulumi.CustomResourceOptions)

Create a SubnetGroup resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SubnetGroupState, opts?: pulumi.CustomResourceOptions): SubnetGroup

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is SubnetGroup

Returns true if the given object is an instance of SubnetGroup. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The ARN of the db subnet group.

property description

public description: pulumi.Output<string>;

The description of the DB subnet group. Defaults to “Managed by Pulumi”.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the DB subnet group. If omitted, this provider will assign a random, unique name.

property namePrefix

public namePrefix: pulumi.Output<string>;

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

property subnetIds

public subnetIds: pulumi.Output<string[]>;

A list of VPC subnet IDs.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A map of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Functions

Function getCluster

getCluster(args: GetClusterArgs, opts?: pulumi.InvokeOptions): Promise<GetClusterResult>

Provides information about an RDS cluster.

Example Usage

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

const clusterName = pulumi.output(aws.rds.getCluster({
    clusterIdentifier: "clusterName",
}, { async: true }));

Function getClusterSnapshot

getClusterSnapshot(args?: GetClusterSnapshotArgs, opts?: pulumi.InvokeOptions): Promise<GetClusterSnapshotResult>

Use this data source to get information about a DB Cluster Snapshot for use when provisioning DB clusters.

NOTE: This data source does not apply to snapshots created on DB Instances. See the aws.rds.Snapshot data source for DB Instance snapshots.

Example Usage

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

const developmentFinalSnapshot = pulumi.output(aws.rds.getClusterSnapshot({
    dbClusterIdentifier: "development_cluster",
    mostRecent: true,
}, { async: true }));
// Use the last snapshot of the dev database before it was destroyed to create
// a new dev database.
const auroraCluster = new aws.rds.Cluster("aurora", {
    clusterIdentifier: "development_cluster",
    dbSubnetGroupName: "my_db_subnet_group",
    snapshotIdentifier: developmentFinalSnapshot.id,
}, { ignoreChanges: ["snapshotIdentifier"] });
const auroraClusterInstance = new aws.rds.ClusterInstance("aurora", {
    clusterIdentifier: auroraCluster.id,
    dbSubnetGroupName: "my_db_subnet_group",
    instanceClass: "db.t2.small",
});

Function getEventCategories

getEventCategories(args?: GetEventCategoriesArgs, opts?: pulumi.InvokeOptions): Promise<GetEventCategoriesResult>

Example Usage

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

const exampleEventCategories = pulumi.output(aws.rds.getEventCategories({ async: true }));

export const example = exampleEventCategories.eventCategories;

Function getInstance

getInstance(args: GetInstanceArgs, opts?: pulumi.InvokeOptions): Promise<GetInstanceResult>

Use this data source to get information about an RDS instance

Example Usage

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

const database = pulumi.output(aws.rds.getInstance({
    dbInstanceIdentifier: "my-test-database",
}, { async: true }));

Function getSnapshot

getSnapshot(args?: GetSnapshotArgs, opts?: pulumi.InvokeOptions): Promise<GetSnapshotResult>

Use this data source to get information about a DB Snapshot for use when provisioning DB instances

NOTE: This data source does not apply to snapshots created on Aurora DB clusters. See the aws.rds.ClusterSnapshot data source for DB Cluster snapshots.

Example Usage

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

const prod = new aws.rds.Instance("prod", {
    allocatedStorage: 10,
    dbSubnetGroupName: "my_database_subnet_group",
    engine: "mysql",
    engineVersion: "5.6.17",
    instanceClass: "db.t2.micro",
    name: "mydb",
    parameterGroupName: "default.mysql5.6",
    password: "bar",
    username: "foo",
});
const latestProdSnapshot = prod.id.apply(id => aws.rds.getSnapshot({
    dbInstanceIdentifier: id,
    mostRecent: true,
}, { async: true }));
// Use the latest production snapshot to create a dev instance.
const dev = new aws.rds.Instance("dev", {
    instanceClass: "db.t2.micro",
    name: "mydbdev",
    snapshotIdentifier: latestProdSnapshot.id,
}, { ignoreChanges: ["snapshotIdentifier"] });

Others

let AuroraEngine

let AuroraEngine: EngineType = "aurora";

let AuroraMysqlEngine

let AuroraMysqlEngine: EngineType = "aurora-mysql";

let AuroraPostgresqlEngine

let AuroraPostgresqlEngine: EngineType = "aurora-postgresql";

interface ClusterArgs

interface ClusterArgs

The set of arguments for constructing a Cluster resource.

property applyImmediately

applyImmediately?: pulumi.Input<boolean>;

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

property availabilityZones

availabilityZones?: pulumi.Input<pulumi.Input<string>[]>;

property backtrackWindow

backtrackWindow?: pulumi.Input<number>;

The target backtrack window, in seconds. Only available for aurora engine currently. To disable backtracking, set this value to 0. Defaults to 0. Must be between 0 and 259200 (72 hours)

property backupRetentionPeriod

backupRetentionPeriod?: pulumi.Input<number>;

The days to retain backups for. Default 1

property clusterIdentifier

clusterIdentifier?: pulumi.Input<string>;

The cluster identifier. If omitted, this provider will assign a random, unique identifier.

property clusterIdentifierPrefix

clusterIdentifierPrefix?: pulumi.Input<string>;

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

property clusterMembers

clusterMembers?: pulumi.Input<pulumi.Input<string>[]>;

List of RDS Instances that are a part of this cluster

property copyTagsToSnapshot

copyTagsToSnapshot?: pulumi.Input<boolean>;

Copy all Cluster tags to snapshots. Default is false.

property databaseName

databaseName?: pulumi.Input<string>;

Name for an automatically created database on cluster creation. There are different naming restrictions per database engine: RDS Naming Constraints

property dbClusterParameterGroupName

dbClusterParameterGroupName?: pulumi.Input<string>;

A cluster parameter group to associate with the cluster.

property dbSubnetGroupName

dbSubnetGroupName?: pulumi.Input<string>;

A DB subnet group to associate with this DB instance. NOTE: This must match the dbSubnetGroupName specified on every aws.rds.ClusterInstance in the cluster.

property deletionProtection

deletionProtection?: pulumi.Input<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.

property enableHttpEndpoint

enableHttpEndpoint?: pulumi.Input<boolean>;

Enable HTTP endpoint (data API). Only valid when engineMode is set to serverless.

property enabledCloudwatchLogsExports

enabledCloudwatchLogsExports?: pulumi.Input<pulumi.Input<string>[]>;

List of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, error, general, slowquery, postgresql (PostgreSQL).

property engine

engine?: pulumi.Input<EngineType>;

The name of the database engine to be used for this DB cluster. Defaults to aurora. Valid Values: aurora, aurora-mysql, aurora-postgresql

property engineMode

engineMode?: pulumi.Input<EngineMode>;

property engineVersion

engineVersion?: pulumi.Input<string>;

property finalSnapshotIdentifier

finalSnapshotIdentifier?: pulumi.Input<string>;

The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.

property globalClusterIdentifier

globalClusterIdentifier?: pulumi.Input<string>;

The global cluster identifier specified on aws.rds.GlobalCluster.

property iamDatabaseAuthenticationEnabled

iamDatabaseAuthenticationEnabled?: pulumi.Input<boolean>;

Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Please see AWS Documentation for availability and limitations.

property iamRoles

iamRoles?: pulumi.Input<pulumi.Input<string>[]>;

A List of ARNs for the IAM roles to associate to the RDS Cluster.

property kmsKeyId

kmsKeyId?: pulumi.Input<string>;

The ARN for the KMS encryption key. When specifying kmsKeyId, storageEncrypted needs to be set to true.

property masterPassword

masterPassword?: pulumi.Input<string>;

Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the RDS Naming Constraints

property masterUsername

masterUsername?: pulumi.Input<string>;

Username for the master DB user. Please refer to the RDS Naming Constraints. This argument does not support in-place updates and cannot be changed during a restore from snapshot.

property port

port?: pulumi.Input<number>;

The port on which the DB accepts connections

property preferredBackupWindow

preferredBackupWindow?: pulumi.Input<string>;

property preferredMaintenanceWindow

preferredMaintenanceWindow?: pulumi.Input<string>;

The weekly time range during which system maintenance can occur, in (UTC) e.g. wed:04:00-wed:04:30

property replicationSourceIdentifier

replicationSourceIdentifier?: pulumi.Input<string>;

ARN of a source DB cluster or DB instance if this DB cluster is to be created as a Read Replica.

property s3Import

s3Import?: pulumi.Input<ClusterS3Import>;

property scalingConfiguration

scalingConfiguration?: pulumi.Input<ClusterScalingConfiguration>;

Nested attribute with scaling properties. Only valid when engineMode is set to serverless. More details below.

property skipFinalSnapshot

skipFinalSnapshot?: pulumi.Input<boolean>;

property snapshotIdentifier

snapshotIdentifier?: pulumi.Input<string>;

Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot.

property sourceRegion

sourceRegion?: pulumi.Input<string>;

The source region for an encrypted replica DB cluster.

property storageEncrypted

storageEncrypted?: pulumi.Input<boolean>;

Specifies whether the DB cluster is encrypted. The default is false for provisioned engineMode and true for serverless engineMode.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the DB cluster.

property vpcSecurityGroupIds

vpcSecurityGroupIds?: pulumi.Input<pulumi.Input<string>[]>;

List of VPC security groups to associate with the Cluster

interface ClusterEndpointArgs

interface ClusterEndpointArgs

The set of arguments for constructing a ClusterEndpoint resource.

property clusterEndpointIdentifier

clusterEndpointIdentifier: pulumi.Input<string>;

The identifier to use for the new endpoint. This parameter is stored as a lowercase string.

property clusterIdentifier

clusterIdentifier: pulumi.Input<string>;

The cluster identifier.

property customEndpointType

customEndpointType: pulumi.Input<string>;

The type of the endpoint. One of: READER , ANY .

property excludedMembers

excludedMembers?: pulumi.Input<pulumi.Input<string>[]>;

property staticMembers

staticMembers?: pulumi.Input<pulumi.Input<string>[]>;

List of DB instance identifiers that are part of the custom endpoint group. Conflicts with excludedMembers.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value map of resource tags

interface ClusterEndpointState

interface ClusterEndpointState

Input properties used for looking up and filtering ClusterEndpoint resources.

property arn

arn?: pulumi.Input<string>;

Amazon Resource Name (ARN) of cluster

property clusterEndpointIdentifier

clusterEndpointIdentifier?: pulumi.Input<string>;

The identifier to use for the new endpoint. This parameter is stored as a lowercase string.

property clusterIdentifier

clusterIdentifier?: pulumi.Input<string>;

The cluster identifier.

property customEndpointType

customEndpointType?: pulumi.Input<string>;

The type of the endpoint. One of: READER , ANY .

property endpoint

endpoint?: pulumi.Input<string>;

A custom endpoint for the Aurora cluster

property excludedMembers

excludedMembers?: pulumi.Input<pulumi.Input<string>[]>;

property staticMembers

staticMembers?: pulumi.Input<pulumi.Input<string>[]>;

List of DB instance identifiers that are part of the custom endpoint group. Conflicts with excludedMembers.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value map of resource tags

interface ClusterInstanceArgs

interface ClusterInstanceArgs

The set of arguments for constructing a ClusterInstance resource.

property applyImmediately

applyImmediately?: pulumi.Input<boolean>;

Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default isfalse.

property autoMinorVersionUpgrade

autoMinorVersionUpgrade?: pulumi.Input<boolean>;

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

property availabilityZone

availabilityZone?: pulumi.Input<string>;

The EC2 Availability Zone that the DB instance is created in. See docs about the details.

property caCertIdentifier

caCertIdentifier?: pulumi.Input<string>;

The identifier of the CA certificate for the DB instance.

property clusterIdentifier

clusterIdentifier: pulumi.Input<string>;

The identifier of the aws.rds.Cluster in which to launch this instance.

property copyTagsToSnapshot

copyTagsToSnapshot?: pulumi.Input<boolean>;

Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance. Default false.

property dbParameterGroupName

dbParameterGroupName?: pulumi.Input<string>;

The name of the DB parameter group to associate with this instance.

property dbSubnetGroupName

dbSubnetGroupName?: pulumi.Input<string>;

A DB subnet group to associate with this DB instance. NOTE: This must match the dbSubnetGroupName of the attached aws.rds.Cluster.

property engine

engine?: pulumi.Input<EngineType>;

property engineVersion

engineVersion?: pulumi.Input<string>;

The database engine version.

property identifier

identifier?: pulumi.Input<string>;

The indentifier for the RDS instance, if omitted, this provider will assign a random, unique identifier.

property identifierPrefix

identifierPrefix?: pulumi.Input<string>;

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

property instanceClass

instanceClass: pulumi.Input<string | InstanceType>;

property monitoringInterval

monitoringInterval?: pulumi.Input<number>;

property monitoringRoleArn

monitoringRoleArn?: pulumi.Input<string>;

property performanceInsightsEnabled

performanceInsightsEnabled?: pulumi.Input<boolean>;

Specifies whether Performance Insights is enabled or not.

property performanceInsightsKmsKeyId

performanceInsightsKmsKeyId?: pulumi.Input<string>;

The ARN for the KMS key to encrypt Performance Insights data. When specifying performanceInsightsKmsKeyId, performanceInsightsEnabled needs to be set to true.

property preferredBackupWindow

preferredBackupWindow?: pulumi.Input<string>;

The daily time range during which automated backups are created if automated backups are enabled. Eg: “04:00-09:00”

property preferredMaintenanceWindow

preferredMaintenanceWindow?: pulumi.Input<string>;

The window to perform maintenance in. Syntax: “ddd:hh24:mi-ddd:hh24:mi”. Eg: “Mon:00:00-Mon:03:00”.

property promotionTier

promotionTier?: pulumi.Input<number>;

Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoted to writer.

property publiclyAccessible

publiclyAccessible?: pulumi.Input<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.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the instance.

interface ClusterInstanceState

interface ClusterInstanceState

Input properties used for looking up and filtering ClusterInstance resources.

property applyImmediately

applyImmediately?: pulumi.Input<boolean>;

Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default isfalse.

property arn

arn?: pulumi.Input<string>;

Amazon Resource Name (ARN) of cluster instance

property autoMinorVersionUpgrade

autoMinorVersionUpgrade?: pulumi.Input<boolean>;

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

property availabilityZone

availabilityZone?: pulumi.Input<string>;

The EC2 Availability Zone that the DB instance is created in. See docs about the details.

property caCertIdentifier

caCertIdentifier?: pulumi.Input<string>;

The identifier of the CA certificate for the DB instance.

property clusterIdentifier

clusterIdentifier?: pulumi.Input<string>;

The identifier of the aws.rds.Cluster in which to launch this instance.

property copyTagsToSnapshot

copyTagsToSnapshot?: pulumi.Input<boolean>;

Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance. Default false.

property dbParameterGroupName

dbParameterGroupName?: pulumi.Input<string>;

The name of the DB parameter group to associate with this instance.

property dbSubnetGroupName

dbSubnetGroupName?: pulumi.Input<string>;

A DB subnet group to associate with this DB instance. NOTE: This must match the dbSubnetGroupName of the attached aws.rds.Cluster.

property dbiResourceId

dbiResourceId?: pulumi.Input<string>;

The region-unique, immutable identifier for the DB instance.

property endpoint

endpoint?: pulumi.Input<string>;

The DNS address for this instance. May not be writable

property engine

engine?: pulumi.Input<EngineType>;

property engineVersion

engineVersion?: pulumi.Input<string>;

The database engine version.

property identifier

identifier?: pulumi.Input<string>;

The indentifier for the RDS instance, if omitted, this provider will assign a random, unique identifier.

property identifierPrefix

identifierPrefix?: pulumi.Input<string>;

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

property instanceClass

instanceClass?: pulumi.Input<string | InstanceType>;

property kmsKeyId

kmsKeyId?: pulumi.Input<string>;

The ARN for the KMS encryption key if one is set to the cluster.

property monitoringInterval

monitoringInterval?: pulumi.Input<number>;

property monitoringRoleArn

monitoringRoleArn?: pulumi.Input<string>;

property performanceInsightsEnabled

performanceInsightsEnabled?: pulumi.Input<boolean>;

Specifies whether Performance Insights is enabled or not.

property performanceInsightsKmsKeyId

performanceInsightsKmsKeyId?: pulumi.Input<string>;

The ARN for the KMS key to encrypt Performance Insights data. When specifying performanceInsightsKmsKeyId, performanceInsightsEnabled needs to be set to true.

property port

port?: pulumi.Input<number>;

The database port

property preferredBackupWindow

preferredBackupWindow?: pulumi.Input<string>;

The daily time range during which automated backups are created if automated backups are enabled. Eg: “04:00-09:00”

property preferredMaintenanceWindow

preferredMaintenanceWindow?: pulumi.Input<string>;

The window to perform maintenance in. Syntax: “ddd:hh24:mi-ddd:hh24:mi”. Eg: “Mon:00:00-Mon:03:00”.

property promotionTier

promotionTier?: pulumi.Input<number>;

Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoted to writer.

property publiclyAccessible

publiclyAccessible?: pulumi.Input<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.

property storageEncrypted

storageEncrypted?: pulumi.Input<boolean>;

Specifies whether the DB cluster is encrypted.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the instance.

property writer

writer?: pulumi.Input<boolean>;

Boolean indicating if this instance is writable. False indicates this instance is a read replica.

interface ClusterParameterGroupArgs

interface ClusterParameterGroupArgs

The set of arguments for constructing a ClusterParameterGroup resource.

property description

description?: pulumi.Input<string>;

The description of the DB cluster parameter group. Defaults to “Managed by Pulumi”.

property family

family: pulumi.Input<string>;

The family of the DB cluster parameter group.

property name

name?: pulumi.Input<string>;

The name of the DB parameter.

property namePrefix

namePrefix?: pulumi.Input<string>;

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

property parameters

parameters?: pulumi.Input<pulumi.Input<ClusterParameterGroupParameter>[]>;

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the resource.

interface ClusterParameterGroupState

interface ClusterParameterGroupState

Input properties used for looking up and filtering ClusterParameterGroup resources.

property arn

arn?: pulumi.Input<string>;

The ARN of the db cluster parameter group.

property description

description?: pulumi.Input<string>;

The description of the DB cluster parameter group. Defaults to “Managed by Pulumi”.

property family

family?: pulumi.Input<string>;

The family of the DB cluster parameter group.

property name

name?: pulumi.Input<string>;

The name of the DB parameter.

property namePrefix

namePrefix?: pulumi.Input<string>;

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

property parameters

parameters?: pulumi.Input<pulumi.Input<ClusterParameterGroupParameter>[]>;

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the resource.

interface ClusterSnapshotArgs

interface ClusterSnapshotArgs

The set of arguments for constructing a ClusterSnapshot resource.

property dbClusterIdentifier

dbClusterIdentifier: pulumi.Input<string>;

The DB Cluster Identifier from which to take the snapshot.

property dbClusterSnapshotIdentifier

dbClusterSnapshotIdentifier: pulumi.Input<string>;

The Identifier for the snapshot.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the DB cluster.

interface ClusterSnapshotState

interface ClusterSnapshotState

Input properties used for looking up and filtering ClusterSnapshot resources.

property allocatedStorage

allocatedStorage?: pulumi.Input<number>;

Specifies the allocated storage size in gigabytes (GB).

property availabilityZones

availabilityZones?: pulumi.Input<pulumi.Input<string>[]>;

List of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.

property dbClusterIdentifier

dbClusterIdentifier?: pulumi.Input<string>;

The DB Cluster Identifier from which to take the snapshot.

property dbClusterSnapshotArn

dbClusterSnapshotArn?: pulumi.Input<string>;

The Amazon Resource Name (ARN) for the DB Cluster Snapshot.

property dbClusterSnapshotIdentifier

dbClusterSnapshotIdentifier?: pulumi.Input<string>;

The Identifier for the snapshot.

property engine

engine?: pulumi.Input<string>;

Specifies the name of the database engine.

property engineVersion

engineVersion?: pulumi.Input<string>;

Version of the database engine for this DB cluster snapshot.

property kmsKeyId

kmsKeyId?: pulumi.Input<string>;

If storageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.

property licenseModel

licenseModel?: pulumi.Input<string>;

License model information for the restored DB cluster.

property port

port?: pulumi.Input<number>;

Port that the DB cluster was listening on at the time of the snapshot.

property snapshotType

snapshotType?: pulumi.Input<string>;

property sourceDbClusterSnapshotArn

sourceDbClusterSnapshotArn?: pulumi.Input<string>;

property status

status?: pulumi.Input<string>;

The status of this DB Cluster Snapshot.

property storageEncrypted

storageEncrypted?: pulumi.Input<boolean>;

Specifies whether the DB cluster snapshot is encrypted.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the DB cluster.

property vpcId

vpcId?: pulumi.Input<string>;

The VPC ID associated with the DB cluster snapshot.

interface ClusterState

interface ClusterState

Input properties used for looking up and filtering Cluster resources.

property applyImmediately

applyImmediately?: pulumi.Input<boolean>;

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

property arn

arn?: pulumi.Input<string>;

Amazon Resource Name (ARN) of cluster

property availabilityZones

availabilityZones?: pulumi.Input<pulumi.Input<string>[]>;

property backtrackWindow

backtrackWindow?: pulumi.Input<number>;

The target backtrack window, in seconds. Only available for aurora engine currently. To disable backtracking, set this value to 0. Defaults to 0. Must be between 0 and 259200 (72 hours)

property backupRetentionPeriod

backupRetentionPeriod?: pulumi.Input<number>;

The days to retain backups for. Default 1

property clusterIdentifier

clusterIdentifier?: pulumi.Input<string>;

The cluster identifier. If omitted, this provider will assign a random, unique identifier.

property clusterIdentifierPrefix

clusterIdentifierPrefix?: pulumi.Input<string>;

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

property clusterMembers

clusterMembers?: pulumi.Input<pulumi.Input<string>[]>;

List of RDS Instances that are a part of this cluster

property clusterResourceId

clusterResourceId?: pulumi.Input<string>;

The RDS Cluster Resource ID

property copyTagsToSnapshot

copyTagsToSnapshot?: pulumi.Input<boolean>;

Copy all Cluster tags to snapshots. Default is false.

property databaseName

databaseName?: pulumi.Input<string>;

Name for an automatically created database on cluster creation. There are different naming restrictions per database engine: RDS Naming Constraints

property dbClusterParameterGroupName

dbClusterParameterGroupName?: pulumi.Input<string>;

A cluster parameter group to associate with the cluster.

property dbSubnetGroupName

dbSubnetGroupName?: pulumi.Input<string>;

A DB subnet group to associate with this DB instance. NOTE: This must match the dbSubnetGroupName specified on every aws.rds.ClusterInstance in the cluster.

property deletionProtection

deletionProtection?: pulumi.Input<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.

property enableHttpEndpoint

enableHttpEndpoint?: pulumi.Input<boolean>;

Enable HTTP endpoint (data API). Only valid when engineMode is set to serverless.

property enabledCloudwatchLogsExports

enabledCloudwatchLogsExports?: pulumi.Input<pulumi.Input<string>[]>;

List of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, error, general, slowquery, postgresql (PostgreSQL).

property endpoint

endpoint?: pulumi.Input<string>;

The DNS address of the RDS instance

property engine

engine?: pulumi.Input<EngineType>;

The name of the database engine to be used for this DB cluster. Defaults to aurora. Valid Values: aurora, aurora-mysql, aurora-postgresql

property engineMode

engineMode?: pulumi.Input<EngineMode>;

property engineVersion

engineVersion?: pulumi.Input<string>;

property finalSnapshotIdentifier

finalSnapshotIdentifier?: pulumi.Input<string>;

The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.

property globalClusterIdentifier

globalClusterIdentifier?: pulumi.Input<string>;

The global cluster identifier specified on aws.rds.GlobalCluster.

property hostedZoneId

hostedZoneId?: pulumi.Input<string>;

The Route53 Hosted Zone ID of the endpoint

property iamDatabaseAuthenticationEnabled

iamDatabaseAuthenticationEnabled?: pulumi.Input<boolean>;

Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Please see AWS Documentation for availability and limitations.

property iamRoles

iamRoles?: pulumi.Input<pulumi.Input<string>[]>;

A List of ARNs for the IAM roles to associate to the RDS Cluster.

property kmsKeyId

kmsKeyId?: pulumi.Input<string>;

The ARN for the KMS encryption key. When specifying kmsKeyId, storageEncrypted needs to be set to true.

property masterPassword

masterPassword?: pulumi.Input<string>;

Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the RDS Naming Constraints

property masterUsername

masterUsername?: pulumi.Input<string>;

Username for the master DB user. Please refer to the RDS Naming Constraints. This argument does not support in-place updates and cannot be changed during a restore from snapshot.

property port

port?: pulumi.Input<number>;

The port on which the DB accepts connections

property preferredBackupWindow

preferredBackupWindow?: pulumi.Input<string>;

property preferredMaintenanceWindow

preferredMaintenanceWindow?: pulumi.Input<string>;

The weekly time range during which system maintenance can occur, in (UTC) e.g. wed:04:00-wed:04:30

property readerEndpoint

readerEndpoint?: pulumi.Input<string>;

A read-only endpoint for the Aurora cluster, automatically load-balanced across replicas

property replicationSourceIdentifier

replicationSourceIdentifier?: pulumi.Input<string>;

ARN of a source DB cluster or DB instance if this DB cluster is to be created as a Read Replica.

property s3Import

s3Import?: pulumi.Input<ClusterS3Import>;

property scalingConfiguration

scalingConfiguration?: pulumi.Input<ClusterScalingConfiguration>;

Nested attribute with scaling properties. Only valid when engineMode is set to serverless. More details below.

property skipFinalSnapshot

skipFinalSnapshot?: pulumi.Input<boolean>;

property snapshotIdentifier

snapshotIdentifier?: pulumi.Input<string>;

Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot.

property sourceRegion

sourceRegion?: pulumi.Input<string>;

The source region for an encrypted replica DB cluster.

property storageEncrypted

storageEncrypted?: pulumi.Input<boolean>;

Specifies whether the DB cluster is encrypted. The default is false for provisioned engineMode and true for serverless engineMode.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the DB cluster.

property vpcSecurityGroupIds

vpcSecurityGroupIds?: pulumi.Input<pulumi.Input<string>[]>;

List of VPC security groups to associate with the Cluster

type EngineMode

type EngineMode = "provisioned" | "serverless" | "parallelquery" | "global";

type EngineType

type EngineType = "aurora" | "aurora-mysql" | "aurora-postgresql";

interface EventSubscriptionArgs

interface EventSubscriptionArgs

The set of arguments for constructing a EventSubscription resource.

property enabled

enabled?: pulumi.Input<boolean>;

A boolean flag to enable/disable the subscription. Defaults to true.

property eventCategories

eventCategories?: pulumi.Input<pulumi.Input<string>[]>;

A list of event categories for a SourceType that you want to subscribe to. See http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html or run aws rds describe-event-categories.

property name

name?: pulumi.Input<string>;

The name of the DB event subscription. By default generated by this provider.

property namePrefix

namePrefix?: pulumi.Input<string>;

The name of the DB event subscription. Conflicts with name.

property snsTopic

snsTopic: pulumi.Input<string>;

The SNS topic to send events to.

property sourceIds

sourceIds?: pulumi.Input<pulumi.Input<string>[]>;

A list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. If specified, a sourceType must also be specified.

property sourceType

sourceType?: pulumi.Input<string>;

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the resource.

interface EventSubscriptionState

interface EventSubscriptionState

Input properties used for looking up and filtering EventSubscription resources.

property arn

arn?: pulumi.Input<string>;

property customerAwsId

customerAwsId?: pulumi.Input<string>;

property enabled

enabled?: pulumi.Input<boolean>;

A boolean flag to enable/disable the subscription. Defaults to true.

property eventCategories

eventCategories?: pulumi.Input<pulumi.Input<string>[]>;

A list of event categories for a SourceType that you want to subscribe to. See http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html or run aws rds describe-event-categories.

property name

name?: pulumi.Input<string>;

The name of the DB event subscription. By default generated by this provider.

property namePrefix

namePrefix?: pulumi.Input<string>;

The name of the DB event subscription. Conflicts with name.

property snsTopic

snsTopic?: pulumi.Input<string>;

The SNS topic to send events to.

property sourceIds

sourceIds?: pulumi.Input<pulumi.Input<string>[]>;

A list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. If specified, a sourceType must also be specified.

property sourceType

sourceType?: pulumi.Input<string>;

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the resource.

interface GetClusterArgs

interface GetClusterArgs

A collection of arguments for invoking getCluster.

property clusterIdentifier

clusterIdentifier: string;

The cluster identifier of the RDS cluster.

property tags

tags?: undefined | {[key: string]: any};

interface GetClusterResult

interface GetClusterResult

A collection of values returned by getCluster.

property arn

arn: string;

property availabilityZones

availabilityZones: string[];

property backtrackWindow

backtrackWindow: number;

property backupRetentionPeriod

backupRetentionPeriod: number;

property clusterIdentifier

clusterIdentifier: string;

property clusterMembers

clusterMembers: string[];

property clusterResourceId

clusterResourceId: string;

property databaseName

databaseName: string;

property dbClusterParameterGroupName

dbClusterParameterGroupName: string;

property dbSubnetGroupName

dbSubnetGroupName: string;

property enabledCloudwatchLogsExports

enabledCloudwatchLogsExports: string[];

property endpoint

endpoint: string;

property engine

engine: string;

property engineVersion

engineVersion: string;

property finalSnapshotIdentifier

finalSnapshotIdentifier: string;

property hostedZoneId

hostedZoneId: string;

property iamDatabaseAuthenticationEnabled

iamDatabaseAuthenticationEnabled: boolean;

property iamRoles

iamRoles: string[];

property id

id: string;

The provider-assigned unique ID for this managed resource.

property kmsKeyId

kmsKeyId: string;

property masterUsername

masterUsername: string;

property port

port: number;

property preferredBackupWindow

preferredBackupWindow: string;

property preferredMaintenanceWindow

preferredMaintenanceWindow: string;

property readerEndpoint

readerEndpoint: string;

property replicationSourceIdentifier

replicationSourceIdentifier: string;

property storageEncrypted

storageEncrypted: boolean;

property tags

tags: {[key: string]: any};

property vpcSecurityGroupIds

vpcSecurityGroupIds: string[];

interface GetClusterSnapshotArgs

interface GetClusterSnapshotArgs

A collection of arguments for invoking getClusterSnapshot.

property dbClusterIdentifier

dbClusterIdentifier?: undefined | string;

Returns the list of snapshots created by the specific db_cluster

property dbClusterSnapshotIdentifier

dbClusterSnapshotIdentifier?: undefined | string;

Returns information on a specific snapshot_id.

property includePublic

includePublic?: undefined | false | true;

Set this value to true to include manual DB Cluster Snapshots that are public and can be copied or restored by any AWS account, otherwise set this value to false. The default is false.

property includeShared

includeShared?: undefined | false | true;

Set this value to true to include shared manual DB Cluster Snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, otherwise set this value to false. The default is false.

property mostRecent

mostRecent?: undefined | false | true;

If more than one result is returned, use the most recent Snapshot.

property snapshotType

snapshotType?: undefined | string;

The type of snapshots to be returned. If you don’t specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. Shared and public DB Cluster Snapshots are not included in the returned results by default. Possible values are, automated, manual, shared and public.

property tags

tags?: undefined | {[key: string]: any};

A map of tags for the resource.

interface GetClusterSnapshotResult

interface GetClusterSnapshotResult

A collection of values returned by getClusterSnapshot.

property allocatedStorage

allocatedStorage: number;

Specifies the allocated storage size in gigabytes (GB).

property availabilityZones

availabilityZones: string[];

List of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.

property dbClusterIdentifier

dbClusterIdentifier?: undefined | string;

Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

property dbClusterSnapshotArn

dbClusterSnapshotArn: string;

The Amazon Resource Name (ARN) for the DB Cluster Snapshot.

property dbClusterSnapshotIdentifier

dbClusterSnapshotIdentifier?: undefined | string;

property engine

engine: string;

Specifies the name of the database engine.

property engineVersion

engineVersion: string;

Version of the database engine for this DB cluster snapshot.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property includePublic

includePublic?: undefined | false | true;

property includeShared

includeShared?: undefined | false | true;

property kmsKeyId

kmsKeyId: string;

If storageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.

property licenseModel

licenseModel: string;

License model information for the restored DB cluster.

property mostRecent

mostRecent?: undefined | false | true;

property port

port: number;

Port that the DB cluster was listening on at the time of the snapshot.

property snapshotCreateTime

snapshotCreateTime: string;

Time when the snapshot was taken, in Universal Coordinated Time (UTC).

property snapshotType

snapshotType?: undefined | string;

property sourceDbClusterSnapshotArn

sourceDbClusterSnapshotArn: string;

property status

status: string;

The status of this DB Cluster Snapshot.

property storageEncrypted

storageEncrypted: boolean;

Specifies whether the DB cluster snapshot is encrypted.

property tags

tags: {[key: string]: any};

A map of tags for the resource.

property vpcId

vpcId: string;

The VPC ID associated with the DB cluster snapshot.

interface GetEventCategoriesArgs

interface GetEventCategoriesArgs

A collection of arguments for invoking getEventCategories.

property sourceType

sourceType?: undefined | string;

The type of source that will be generating the events. Valid options are db-instance, db-security-group, db-parameter-group, db-snapshot, db-cluster or db-cluster-snapshot.

interface GetEventCategoriesResult

interface GetEventCategoriesResult

A collection of values returned by getEventCategories.

property eventCategories

eventCategories: string[];

A list of the event categories.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property sourceType

sourceType?: undefined | string;

interface GetInstanceArgs

interface GetInstanceArgs

A collection of arguments for invoking getInstance.

property dbInstanceIdentifier

dbInstanceIdentifier: string;

The name of the RDS instance

property tags

tags?: undefined | {[key: string]: any};

interface GetInstanceResult

interface GetInstanceResult

A collection of values returned by getInstance.

property address

address: string;

The hostname of the RDS instance. See also endpoint and port.

property allocatedStorage

allocatedStorage: number;

Specifies the allocated storage size specified in gigabytes.

property autoMinorVersionUpgrade

autoMinorVersionUpgrade: boolean;

Indicates that minor version patches are applied automatically.

property availabilityZone

availabilityZone: string;

Specifies the name of the Availability Zone the DB instance is located in.

property backupRetentionPeriod

backupRetentionPeriod: number;

Specifies the number of days for which automatic DB snapshots are retained.

property caCertIdentifier

caCertIdentifier: string;

Specifies the identifier of the CA certificate for the DB instance.

property dbClusterIdentifier

dbClusterIdentifier: string;

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

property dbInstanceArn

dbInstanceArn: string;

The Amazon Resource Name (ARN) for the DB instance.

property dbInstanceClass

dbInstanceClass: string;

Contains the name of the compute and memory capacity class of the DB instance.

property dbInstanceIdentifier

dbInstanceIdentifier: string;

property dbInstancePort

dbInstancePort: number;

Specifies the port that the DB instance listens on.

property dbName

dbName: string;

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

property dbParameterGroups

dbParameterGroups: string[];

Provides the list of DB parameter groups applied to this DB instance.

property dbSecurityGroups

dbSecurityGroups: string[];

Provides List of DB security groups associated to this DB instance.

property dbSubnetGroup

dbSubnetGroup: string;

Specifies the name of the subnet group associated with the DB instance.

property enabledCloudwatchLogsExports

enabledCloudwatchLogsExports: string[];

List of log types to export to cloudwatch.

property endpoint

endpoint: string;

The connection endpoint in address:port format.

property engine

engine: string;

Provides the name of the database engine to be used for this DB instance.

property engineVersion

engineVersion: string;

Indicates the database engine version.

property hostedZoneId

hostedZoneId: string;

The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record).

property id

id: string;

The provider-assigned unique ID for this managed resource.

property iops

iops: number;

Specifies the Provisioned IOPS (I/O operations per second) value.

property kmsKeyId

kmsKeyId: string;

If StorageEncrypted is true, the KMS key identifier for the encrypted DB instance.

property licenseModel

licenseModel: string;

License model information for this DB instance.

property masterUsername

masterUsername: string;

Contains the master username for the DB instance.

property monitoringInterval

monitoringInterval: number;

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

property monitoringRoleArn

monitoringRoleArn: string;

The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to CloudWatch Logs.

property multiAz

multiAz: boolean;

Specifies if the DB instance is a Multi-AZ deployment.

property optionGroupMemberships

optionGroupMemberships: string[];

Provides the list of option group memberships for this DB instance.

property port

port: number;

The database port.

property preferredBackupWindow

preferredBackupWindow: string;

Specifies the daily time range during which automated backups are created.

property preferredMaintenanceWindow

preferredMaintenanceWindow: string;

Specifies the weekly time range during which system maintenance can occur in UTC.

property publiclyAccessible

publiclyAccessible: boolean;

Specifies the accessibility options for the DB instance.

property replicateSourceDb

replicateSourceDb: string;

The identifier of the source DB that this is a replica of.

property resourceId

resourceId: string;

The RDS Resource ID of this instance.

property storageEncrypted

storageEncrypted: boolean;

Specifies whether the DB instance is encrypted.

property storageType

storageType: string;

Specifies the storage type associated with DB instance.

property tags

tags: {[key: string]: any};

property timezone

timezone: string;

The time zone of the DB instance.

property vpcSecurityGroups

vpcSecurityGroups: string[];

Provides a list of VPC security group elements that the DB instance belongs to.

interface GetSnapshotArgs

interface GetSnapshotArgs

A collection of arguments for invoking getSnapshot.

property dbInstanceIdentifier

dbInstanceIdentifier?: undefined | string;

Returns the list of snapshots created by the specific db_instance

property dbSnapshotIdentifier

dbSnapshotIdentifier?: undefined | string;

Returns information on a specific snapshot_id.

property includePublic

includePublic?: undefined | false | true;

Set this value to true to include manual DB snapshots that are public and can be copied or restored by any AWS account, otherwise set this value to false. The default is false.

property includeShared

includeShared?: undefined | false | true;

Set this value to true to include shared manual DB snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, otherwise set this value to false. The default is false.

property mostRecent

mostRecent?: undefined | false | true;

If more than one result is returned, use the most recent Snapshot.

property snapshotType

snapshotType?: undefined | string;

The type of snapshots to be returned. If you don’t specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. Possible values are, automated, manual, shared and public.

interface GetSnapshotResult

interface GetSnapshotResult

A collection of values returned by getSnapshot.

property allocatedStorage

allocatedStorage: number;

Specifies the allocated storage size in gigabytes (GB).

property availabilityZone

availabilityZone: string;

Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

property dbInstanceIdentifier

dbInstanceIdentifier?: undefined | string;

property dbSnapshotArn

dbSnapshotArn: string;

The Amazon Resource Name (ARN) for the DB snapshot.

property dbSnapshotIdentifier

dbSnapshotIdentifier?: undefined | string;

property encrypted

encrypted: boolean;

Specifies whether the DB snapshot is encrypted.

property engine

engine: string;

Specifies the name of the database engine.

property engineVersion

engineVersion: string;

Specifies the version of the database engine.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property includePublic

includePublic?: undefined | false | true;

property includeShared

includeShared?: undefined | false | true;

property iops

iops: number;

Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

property kmsKeyId

kmsKeyId: string;

The ARN for the KMS encryption key.

property licenseModel

licenseModel: string;

License model information for the restored DB instance.

property mostRecent

mostRecent?: undefined | false | true;

property optionGroupName

optionGroupName: string;

Provides the option group name for the DB snapshot.

property port

port: number;

property snapshotCreateTime

snapshotCreateTime: string;

Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

property snapshotType

snapshotType?: undefined | string;

property sourceDbSnapshotIdentifier

sourceDbSnapshotIdentifier: string;

The DB snapshot Arn that the DB snapshot was copied from. It only has value in case of cross customer or cross region copy.

property sourceRegion

sourceRegion: string;

The region that the DB snapshot was created in or copied from.

property status

status: string;

Specifies the status of this DB snapshot.

property storageType

storageType: string;

Specifies the storage type associated with DB snapshot.

property vpcId

vpcId: string;

Specifies the ID of the VPC associated with the DB snapshot.

interface GlobalClusterArgs

interface GlobalClusterArgs

The set of arguments for constructing a GlobalCluster resource.

property databaseName

databaseName?: pulumi.Input<string>;

Name for an automatically created database on cluster creation.

property deletionProtection

deletionProtection?: pulumi.Input<boolean>;

If the Global Cluster should have deletion protection enabled. The database can’t be deleted when this value is set to true. The default is false.

property engine

engine?: pulumi.Input<string>;

Name of the database engine to be used for this DB cluster. Valid values: aurora, aurora-mysql, aurora-postgresql. Defaults to aurora.

property engineVersion

engineVersion?: pulumi.Input<string>;

property globalClusterIdentifier

globalClusterIdentifier: pulumi.Input<string>;

The global cluster identifier.

property storageEncrypted

storageEncrypted?: pulumi.Input<boolean>;

Specifies whether the DB cluster is encrypted. The default is false.

interface GlobalClusterState

interface GlobalClusterState

Input properties used for looking up and filtering GlobalCluster resources.

property arn

arn?: pulumi.Input<string>;

RDS Global Cluster Amazon Resource Name (ARN)

property databaseName

databaseName?: pulumi.Input<string>;

Name for an automatically created database on cluster creation.

property deletionProtection

deletionProtection?: pulumi.Input<boolean>;

If the Global Cluster should have deletion protection enabled. The database can’t be deleted when this value is set to true. The default is false.

property engine

engine?: pulumi.Input<string>;

Name of the database engine to be used for this DB cluster. Valid values: aurora, aurora-mysql, aurora-postgresql. Defaults to aurora.

property engineVersion

engineVersion?: pulumi.Input<string>;

property globalClusterIdentifier

globalClusterIdentifier?: pulumi.Input<string>;

The global cluster identifier.

property globalClusterResourceId

globalClusterResourceId?: pulumi.Input<string>;

AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed

property storageEncrypted

storageEncrypted?: pulumi.Input<boolean>;

Specifies whether the DB cluster is encrypted. The default is false.

let GlobalEngine

let GlobalEngine: EngineMode = "global";

interface InstanceArgs

interface InstanceArgs

The set of arguments for constructing a Instance resource.

property allocatedStorage

allocatedStorage?: pulumi.Input<number>;

property allowMajorVersionUpgrade

allowMajorVersionUpgrade?: pulumi.Input<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.

property applyImmediately

applyImmediately?: pulumi.Input<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.

property autoMinorVersionUpgrade

autoMinorVersionUpgrade?: pulumi.Input<boolean>;

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

property availabilityZone

availabilityZone?: pulumi.Input<string>;

The AZ for the RDS instance.

property backupRetentionPeriod

backupRetentionPeriod?: pulumi.Input<number>;

The days to retain backups for. Must be between 0 and 35. Must be greater than 0 if the database is used as a source for a Read Replica. [See Read Replica][1].

property backupWindow

backupWindow?: pulumi.Input<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 maintenanceWindow.

property caCertIdentifier

caCertIdentifier?: pulumi.Input<string>;

The identifier of the CA certificate for the DB instance.

property characterSetName

characterSetName?: pulumi.Input<string>;

property copyTagsToSnapshot

copyTagsToSnapshot?: pulumi.Input<boolean>;

Copy all Instance tags to snapshots. Default is false.

property dbSubnetGroupName

dbSubnetGroupName?: pulumi.Input<string>;

property deleteAutomatedBackups

deleteAutomatedBackups?: pulumi.Input<boolean>;

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

property deletionProtection

deletionProtection?: pulumi.Input<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.

property domain

domain?: pulumi.Input<string>;

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

property domainIamRoleName

domainIamRoleName?: pulumi.Input<string>;

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

property enabledCloudwatchLogsExports

enabledCloudwatchLogsExports?: pulumi.Input<pulumi.Input<string>[]>;

property engine

engine?: pulumi.Input<string>;

property engineVersion

engineVersion?: pulumi.Input<string>;

property finalSnapshotIdentifier

finalSnapshotIdentifier?: pulumi.Input<string>;

The name of your final DB snapshot when this DB instance is deleted. Must be provided if skipFinalSnapshot is set to false.

property iamDatabaseAuthenticationEnabled

iamDatabaseAuthenticationEnabled?: pulumi.Input<boolean>;

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

property identifier

identifier?: pulumi.Input<string>;

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

property identifierPrefix

identifierPrefix?: pulumi.Input<string>;

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

property instanceClass

instanceClass: pulumi.Input<string | InstanceType>;

The instance type of the RDS instance.

property iops

iops?: pulumi.Input<number>;

The amount of provisioned IOPS. Setting this implies a storageType of “io1”.

property kmsKeyId

kmsKeyId?: pulumi.Input<string>;

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

property licenseModel

licenseModel?: pulumi.Input<string>;

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

property maintenanceWindow

maintenanceWindow?: pulumi.Input<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.

property maxAllocatedStorage

maxAllocatedStorage?: pulumi.Input<number>;

property monitoringInterval

monitoringInterval?: pulumi.Input<number>;

property monitoringRoleArn

monitoringRoleArn?: pulumi.Input<string>;

property multiAz

multiAz?: pulumi.Input<boolean>;

Specifies if the RDS instance is multi-AZ

property name

name?: pulumi.Input<string>;

property optionGroupName

optionGroupName?: pulumi.Input<string>;

Name of the DB option group to associate.

property parameterGroupName

parameterGroupName?: pulumi.Input<string>;

Name of the DB parameter group to associate.

property password

password?: pulumi.Input<string>;

(Required unless a snapshotIdentifier or replicateSourceDb is provided) Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file.

property performanceInsightsEnabled

performanceInsightsEnabled?: pulumi.Input<boolean>;

Specifies whether Performance Insights are enabled. Defaults to false.

property performanceInsightsKmsKeyId

performanceInsightsKmsKeyId?: pulumi.Input<string>;

property performanceInsightsRetentionPeriod

performanceInsightsRetentionPeriod?: pulumi.Input<number>;

property port

port?: pulumi.Input<number>;

The port on which the DB accepts connections.

property publiclyAccessible

publiclyAccessible?: pulumi.Input<boolean>;

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

property replicateSourceDb

replicateSourceDb?: pulumi.Input<string>;

property s3Import

s3Import?: pulumi.Input<InstanceS3Import>;

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

property securityGroupNames

securityGroupNames?: pulumi.Input<pulumi.Input<string>[]>;

List of DB Security Groups to associate. Only used for DB Instances on the EC2-Classic Platform.

property skipFinalSnapshot

skipFinalSnapshot?: pulumi.Input<boolean>;

property snapshotIdentifier

snapshotIdentifier?: pulumi.Input<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.

property storageEncrypted

storageEncrypted?: pulumi.Input<boolean>;

property storageType

storageType?: pulumi.Input<string | StorageType>;

One of “standard” (magnetic), “gp2” (general purpose SSD), or “io1” (provisioned IOPS SSD). The default is “io1” if iops is specified, “gp2” if not.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the resource.

property timezone

timezone?: pulumi.Input<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.

property username

username?: pulumi.Input<string>;

(Required unless a snapshotIdentifier or replicateSourceDb is provided) Username for the master DB user.

property vpcSecurityGroupIds

vpcSecurityGroupIds?: pulumi.Input<pulumi.Input<string>[]>;

List of VPC security groups to associate.

interface InstanceState

interface InstanceState

Input properties used for looking up and filtering Instance resources.

property address

address?: pulumi.Input<string>;

The hostname of the RDS instance. See also endpoint and port.

property allocatedStorage

allocatedStorage?: pulumi.Input<number>;

property allowMajorVersionUpgrade

allowMajorVersionUpgrade?: pulumi.Input<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.

property applyImmediately

applyImmediately?: pulumi.Input<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.

property arn

arn?: pulumi.Input<string>;

The ARN of the RDS instance.

property autoMinorVersionUpgrade

autoMinorVersionUpgrade?: pulumi.Input<boolean>;

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

property availabilityZone

availabilityZone?: pulumi.Input<string>;

The AZ for the RDS instance.

property backupRetentionPeriod

backupRetentionPeriod?: pulumi.Input<number>;

The days to retain backups for. Must be between 0 and 35. Must be greater than 0 if the database is used as a source for a Read Replica. [See Read Replica][1].

property backupWindow

backupWindow?: pulumi.Input<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 maintenanceWindow.

property caCertIdentifier

caCertIdentifier?: pulumi.Input<string>;

The identifier of the CA certificate for the DB instance.

property characterSetName

characterSetName?: pulumi.Input<string>;

property copyTagsToSnapshot

copyTagsToSnapshot?: pulumi.Input<boolean>;

Copy all Instance tags to snapshots. Default is false.

property dbSubnetGroupName

dbSubnetGroupName?: pulumi.Input<string>;

property deleteAutomatedBackups

deleteAutomatedBackups?: pulumi.Input<boolean>;

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

property deletionProtection

deletionProtection?: pulumi.Input<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.

property domain

domain?: pulumi.Input<string>;

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

property domainIamRoleName

domainIamRoleName?: pulumi.Input<string>;

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

property enabledCloudwatchLogsExports

enabledCloudwatchLogsExports?: pulumi.Input<pulumi.Input<string>[]>;

property endpoint

endpoint?: pulumi.Input<string>;

The connection endpoint in address:port format.

property engine

engine?: pulumi.Input<string>;

property engineVersion

engineVersion?: pulumi.Input<string>;

property finalSnapshotIdentifier

finalSnapshotIdentifier?: pulumi.Input<string>;

The name of your final DB snapshot when this DB instance is deleted. Must be provided if skipFinalSnapshot is set to false.

property hostedZoneId

hostedZoneId?: pulumi.Input<string>;

The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record).

property iamDatabaseAuthenticationEnabled

iamDatabaseAuthenticationEnabled?: pulumi.Input<boolean>;

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

property identifier

identifier?: pulumi.Input<string>;

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

property identifierPrefix

identifierPrefix?: pulumi.Input<string>;

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

property instanceClass

instanceClass?: pulumi.Input<string | InstanceType>;

The instance type of the RDS instance.

property iops

iops?: pulumi.Input<number>;

The amount of provisioned IOPS. Setting this implies a storageType of “io1”.

property kmsKeyId

kmsKeyId?: pulumi.Input<string>;

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

property licenseModel

licenseModel?: pulumi.Input<string>;

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

property maintenanceWindow

maintenanceWindow?: pulumi.Input<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.

property maxAllocatedStorage

maxAllocatedStorage?: pulumi.Input<number>;

property monitoringInterval

monitoringInterval?: pulumi.Input<number>;

property monitoringRoleArn

monitoringRoleArn?: pulumi.Input<string>;

property multiAz

multiAz?: pulumi.Input<boolean>;

Specifies if the RDS instance is multi-AZ

property name

name?: pulumi.Input<string>;

property optionGroupName

optionGroupName?: pulumi.Input<string>;

Name of the DB option group to associate.

property parameterGroupName

parameterGroupName?: pulumi.Input<string>;

Name of the DB parameter group to associate.

property password

password?: pulumi.Input<string>;

(Required unless a snapshotIdentifier or replicateSourceDb is provided) Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file.

property performanceInsightsEnabled

performanceInsightsEnabled?: pulumi.Input<boolean>;

Specifies whether Performance Insights are enabled. Defaults to false.

property performanceInsightsKmsKeyId

performanceInsightsKmsKeyId?: pulumi.Input<string>;

property performanceInsightsRetentionPeriod

performanceInsightsRetentionPeriod?: pulumi.Input<number>;

property port

port?: pulumi.Input<number>;

The port on which the DB accepts connections.

property publiclyAccessible

publiclyAccessible?: pulumi.Input<boolean>;

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

property replicas

replicas?: pulumi.Input<pulumi.Input<string>[]>;

property replicateSourceDb

replicateSourceDb?: pulumi.Input<string>;

property resourceId

resourceId?: pulumi.Input<string>;

The RDS Resource ID of this instance.

property s3Import

s3Import?: pulumi.Input<InstanceS3Import>;

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

property securityGroupNames

securityGroupNames?: pulumi.Input<pulumi.Input<string>[]>;

List of DB Security Groups to associate. Only used for DB Instances on the EC2-Classic Platform.

property skipFinalSnapshot

skipFinalSnapshot?: pulumi.Input<boolean>;

property snapshotIdentifier

snapshotIdentifier?: pulumi.Input<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.

property status

status?: pulumi.Input<string>;

The RDS instance status.

property storageEncrypted

storageEncrypted?: pulumi.Input<boolean>;

property storageType

storageType?: pulumi.Input<string | StorageType>;

One of “standard” (magnetic), “gp2” (general purpose SSD), or “io1” (provisioned IOPS SSD). The default is “io1” if iops is specified, “gp2” if not.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the resource.

property timezone

timezone?: pulumi.Input<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.

property username

username?: pulumi.Input<string>;

(Required unless a snapshotIdentifier or replicateSourceDb is provided) Username for the master DB user.

property vpcSecurityGroupIds

vpcSecurityGroupIds?: pulumi.Input<pulumi.Input<string>[]>;

List of VPC security groups to associate.

type InstanceType

type InstanceType = "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.16xlarge" | "db.m5.large" | "db.m5.xlarge" | "db.m5.2xlarge" | "db.m5.4xlarge" | "db.m5.12xlarge" | "db.m5.24xlarge" | "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.x1.16xlarge" | "db.x1.32xlarge" | "db.x1e.xlarge" | "db.x1e.2xlarge" | "db.x1e.4xlarge" | "db.x1e.8xlarge" | "db.x1e.32xlarge";

interface OptionGroupArgs

interface OptionGroupArgs

The set of arguments for constructing a OptionGroup resource.

property engineName

engineName: pulumi.Input<string>;

Specifies the name of the engine that this option group should be associated with.

property majorEngineVersion

majorEngineVersion: pulumi.Input<string>;

Specifies the major version of the engine that this option group should be associated with.

property name

name?: pulumi.Input<string>;

The Name of the setting.

property namePrefix

namePrefix?: pulumi.Input<string>;

Creates a unique name beginning with the specified prefix. Conflicts with name. Must be lowercase, to match as it is stored in AWS.

property optionGroupDescription

optionGroupDescription?: pulumi.Input<string>;

The description of the option group. Defaults to “Managed by Pulumi”.

property options

options?: pulumi.Input<pulumi.Input<OptionGroupOption>[]>;

A list of Options to apply.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the resource.

interface OptionGroupState

interface OptionGroupState

Input properties used for looking up and filtering OptionGroup resources.

property arn

arn?: pulumi.Input<string>;

The ARN of the db option group.

property engineName

engineName?: pulumi.Input<string>;

Specifies the name of the engine that this option group should be associated with.

property majorEngineVersion

majorEngineVersion?: pulumi.Input<string>;

Specifies the major version of the engine that this option group should be associated with.

property name

name?: pulumi.Input<string>;

The Name of the setting.

property namePrefix

namePrefix?: pulumi.Input<string>;

Creates a unique name beginning with the specified prefix. Conflicts with name. Must be lowercase, to match as it is stored in AWS.

property optionGroupDescription

optionGroupDescription?: pulumi.Input<string>;

The description of the option group. Defaults to “Managed by Pulumi”.

property options

options?: pulumi.Input<pulumi.Input<OptionGroupOption>[]>;

A list of Options to apply.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the resource.

let ParallelQueryEngine

let ParallelQueryEngine: EngineMode = "parallelquery";

interface ParameterGroupArgs

interface ParameterGroupArgs

The set of arguments for constructing a ParameterGroup resource.

property description

description?: pulumi.Input<string>;

The description of the DB parameter group. Defaults to “Managed by Pulumi”.

property family

family: pulumi.Input<string>;

The family of the DB parameter group.

property name

name?: pulumi.Input<string>;

The name of the DB parameter.

property namePrefix

namePrefix?: pulumi.Input<string>;

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

property parameters

parameters?: pulumi.Input<pulumi.Input<ParameterGroupParameter>[]>;

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the resource.

interface ParameterGroupState

interface ParameterGroupState

Input properties used for looking up and filtering ParameterGroup resources.

property arn

arn?: pulumi.Input<string>;

The ARN of the db parameter group.

property description

description?: pulumi.Input<string>;

The description of the DB parameter group. Defaults to “Managed by Pulumi”.

property family

family?: pulumi.Input<string>;

The family of the DB parameter group.

property name

name?: pulumi.Input<string>;

The name of the DB parameter.

property namePrefix

namePrefix?: pulumi.Input<string>;

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

property parameters

parameters?: pulumi.Input<pulumi.Input<ParameterGroupParameter>[]>;

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the resource.

let ProvisionedEngine

let ProvisionedEngine: EngineMode = "provisioned";

interface RoleAssociationArgs

interface RoleAssociationArgs

The set of arguments for constructing a RoleAssociation resource.

property dbInstanceIdentifier

dbInstanceIdentifier: pulumi.Input<string>;

DB Instance Identifier to associate with the IAM Role.

property featureName

featureName: pulumi.Input<string>;

property roleArn

roleArn: pulumi.Input<string>;

Amazon Resource Name (ARN) of the IAM Role to associate with the DB Instance.

interface RoleAssociationState

interface RoleAssociationState

Input properties used for looking up and filtering RoleAssociation resources.

property dbInstanceIdentifier

dbInstanceIdentifier?: pulumi.Input<string>;

DB Instance Identifier to associate with the IAM Role.

property featureName

featureName?: pulumi.Input<string>;

property roleArn

roleArn?: pulumi.Input<string>;

Amazon Resource Name (ARN) of the IAM Role to associate with the DB Instance.

interface SecurityGroupArgs

interface SecurityGroupArgs

The set of arguments for constructing a SecurityGroup resource.

property description

description?: pulumi.Input<string>;

The description of the DB security group. Defaults to “Managed by Pulumi”.

property ingress

ingress: pulumi.Input<pulumi.Input<SecurityGroupIngress>[]>;

A list of ingress rules.

property name

name?: pulumi.Input<string>;

The name of the DB security group.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the resource.

interface SecurityGroupState

interface SecurityGroupState

Input properties used for looking up and filtering SecurityGroup resources.

property arn

arn?: pulumi.Input<string>;

The arn of the DB security group.

property description

description?: pulumi.Input<string>;

The description of the DB security group. Defaults to “Managed by Pulumi”.

property ingress

ingress?: pulumi.Input<pulumi.Input<SecurityGroupIngress>[]>;

A list of ingress rules.

property name

name?: pulumi.Input<string>;

The name of the DB security group.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the resource.

let ServerlessEngine

let ServerlessEngine: EngineMode = "serverless";

interface SnapshotArgs

interface SnapshotArgs

The set of arguments for constructing a Snapshot resource.

property dbInstanceIdentifier

dbInstanceIdentifier: pulumi.Input<string>;

The DB Instance Identifier from which to take the snapshot.

property dbSnapshotIdentifier

dbSnapshotIdentifier: pulumi.Input<string>;

The Identifier for the snapshot.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value map of resource tags

interface SnapshotState

interface SnapshotState

Input properties used for looking up and filtering Snapshot resources.

property allocatedStorage

allocatedStorage?: pulumi.Input<number>;

Specifies the allocated storage size in gigabytes (GB).

property availabilityZone

availabilityZone?: pulumi.Input<string>;

Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

property dbInstanceIdentifier

dbInstanceIdentifier?: pulumi.Input<string>;

The DB Instance Identifier from which to take the snapshot.

property dbSnapshotArn

dbSnapshotArn?: pulumi.Input<string>;

The Amazon Resource Name (ARN) for the DB snapshot.

property dbSnapshotIdentifier

dbSnapshotIdentifier?: pulumi.Input<string>;

The Identifier for the snapshot.

property encrypted

encrypted?: pulumi.Input<boolean>;

Specifies whether the DB snapshot is encrypted.

property engine

engine?: pulumi.Input<string>;

Specifies the name of the database engine.

property engineVersion

engineVersion?: pulumi.Input<string>;

Specifies the version of the database engine.

property iops

iops?: pulumi.Input<number>;

Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

property kmsKeyId

kmsKeyId?: pulumi.Input<string>;

The ARN for the KMS encryption key.

property licenseModel

licenseModel?: pulumi.Input<string>;

License model information for the restored DB instance.

property optionGroupName

optionGroupName?: pulumi.Input<string>;

Provides the option group name for the DB snapshot.

property port

port?: pulumi.Input<number>;

property snapshotType

snapshotType?: pulumi.Input<string>;

property sourceDbSnapshotIdentifier

sourceDbSnapshotIdentifier?: pulumi.Input<string>;

The DB snapshot Arn that the DB snapshot was copied from. It only has value in case of cross customer or cross region copy.

property sourceRegion

sourceRegion?: pulumi.Input<string>;

The region that the DB snapshot was created in or copied from.

property status

status?: pulumi.Input<string>;

Specifies the status of this DB snapshot.

property storageType

storageType?: pulumi.Input<string>;

Specifies the storage type associated with DB snapshot.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value map of resource tags

property vpcId

vpcId?: pulumi.Input<string>;

Specifies the storage type associated with DB snapshot.

type StorageType

type StorageType = "standard" | "gp2" | "io1";

interface SubnetGroupArgs

interface SubnetGroupArgs

The set of arguments for constructing a SubnetGroup resource.

property description

description?: pulumi.Input<string>;

The description of the DB subnet group. Defaults to “Managed by Pulumi”.

property name

name?: pulumi.Input<string>;

The name of the DB subnet group. If omitted, this provider will assign a random, unique name.

property namePrefix

namePrefix?: pulumi.Input<string>;

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

property subnetIds

subnetIds: pulumi.Input<pulumi.Input<string>[]>;

A list of VPC subnet IDs.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the resource.

interface SubnetGroupState

interface SubnetGroupState

Input properties used for looking up and filtering SubnetGroup resources.

property arn

arn?: pulumi.Input<string>;

The ARN of the db subnet group.

property description

description?: pulumi.Input<string>;

The description of the DB subnet group. Defaults to “Managed by Pulumi”.

property name

name?: pulumi.Input<string>;

The name of the DB subnet group. If omitted, this provider will assign a random, unique name.

property namePrefix

namePrefix?: pulumi.Input<string>;

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

property subnetIds

subnetIds?: pulumi.Input<pulumi.Input<string>[]>;

A list of VPC subnet IDs.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the resource.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Module rds

namespace InstanceTypes

namespace StorageTypes

Resources

Functions

Others

namespace InstanceTypes

namespace StorageTypes

Resources

Example Usage

Aurora MySQL 2.x (MySQL 5.7)

Aurora MySQL 1.x (MySQL 5.6)

Aurora with PostgreSQL engine

Aurora Multi-Master Cluster

Example Usage

Example Usage