Edit This Page

rds

class pulumi_aws.rds.Cluster(resource_name, opts=None, apply_immediately=None, availability_zones=None, backtrack_window=None, backup_retention_period=None, cluster_identifier=None, cluster_identifier_prefix=None, cluster_members=None, database_name=None, db_cluster_parameter_group_name=None, db_subnet_group_name=None, deletion_protection=None, enabled_cloudwatch_logs_exports=None, engine=None, engine_mode=None, engine_version=None, final_snapshot_identifier=None, global_cluster_identifier=None, iam_database_authentication_enabled=None, iam_roles=None, kms_key_id=None, master_password=None, master_username=None, port=None, preferred_backup_window=None, preferred_maintenance_window=None, replication_source_identifier=None, s3_import=None, scaling_configuration=None, skip_final_snapshot=None, snapshot_identifier=None, source_region=None, storage_encrypted=None, tags=None, vpc_security_group_ids=None, __name__=None, __opts__=None)

Manages a [RDS Aurora Cluster][2]. To manage cluster instances that inherit configuration from the cluster (when not running the cluster in serverless engine mode), see the ``aws_rds_cluster_instance` resource <https://www.terraform.io/docs/providers/aws/r/rds_cluster_instance.html>`_. To manage non-Aurora databases (e.g. MySQL, PostgreSQL, SQL Server, etc.), see the ``aws_db_instance` resource <https://www.terraform.io/docs/providers/aws/r/db_instance.html>`_.

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 a RDS Cluster can occur when you manually change a parameter, such as port, and are reflected in the next maintenance window. Because of this, Terraform may report a difference in its planning phase because a modification has not yet taken place. You can use the apply_immediately flag to instruct the service to apply the change immediately (see documentation below).

Note: using apply_immediately can result in a brief downtime as the server reboots. See the AWS Docs on [RDS Maintenance][4] for more information.

Note: All arguments including the username and password will be stored in the raw state as plain-text. Read more about sensitive data in state.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • apply_immediately (pulumi.Input[bool]) – Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false. See Amazon RDS Documentation for more information.
  • availability_zones (pulumi.Input[list]) – A list of EC2 Availability Zones that instances in the DB cluster can be created in
  • backtrack_window (pulumi.Input[float]) – 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)
  • backup_retention_period (pulumi.Input[float]) – The days to retain backups for. Default 1
  • cluster_identifier (pulumi.Input[str]) – The cluster identifier. If omitted, Terraform will assign a random, unique identifier.
  • cluster_identifier_prefix (pulumi.Input[str]) – Creates a unique cluster identifier beginning with the specified prefix. Conflicts with cluster_identifier.
  • cluster_members (pulumi.Input[list]) – List of RDS Instances that are a part of this cluster
  • database_name (pulumi.Input[str]) – Name for an automatically created database on cluster creation. There are different naming restrictions per database engine: [RDS Naming Constraints][5]
  • db_cluster_parameter_group_name (pulumi.Input[str]) – A cluster parameter group to associate with the cluster.
  • db_subnet_group_name (pulumi.Input[str]) – A DB subnet group to associate with this DB instance. NOTE: This must match the db_subnet_group_name specified on every ``aws_rds_cluster_instance` <https://www.terraform.io/docs/providers/aws/r/rds_cluster_instance.html>`_ in the cluster.
  • deletion_protection (pulumi.Input[bool]) – If the DB instance should have deletion protection enabled. The database can’t be deleted when this value is set to true. The default is false.
  • enabled_cloudwatch_logs_exports (pulumi.Input[list]) – 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.
  • engine (pulumi.Input[str]) – The name of the database engine to be used for this DB cluster. Defaults to aurora. Valid Values: aurora, aurora-mysql, aurora-postgresql
  • engine_mode (pulumi.Input[str]) – The database engine mode. Valid values: global, parallelquery, provisioned, serverless. Defaults to: provisioned. See the RDS User Guide for limitations when using serverless.
  • engine_version (pulumi.Input[str]) – The database engine version. Updating this argument results in an outage.
  • final_snapshot_identifier (pulumi.Input[str]) – The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.
  • global_cluster_identifier (pulumi.Input[str]) – The global cluster identifier specified on ``aws_rds_global_cluster` <https://www.terraform.io/docs/providers/aws/r/rds_global_cluster.html>`_.
  • iam_database_authentication_enabled (pulumi.Input[bool]) – 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.
  • iam_roles (pulumi.Input[list]) – A List of ARNs for the IAM roles to associate to the RDS Cluster.
  • kms_key_id (pulumi.Input[str]) – The ARN for the KMS encryption key. When specifying kms_key_id, storage_encrypted needs to be set to true.
  • master_password (pulumi.Input[str]) – 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][5]
  • master_username (pulumi.Input[str]) – Username for the master DB user. Please refer to the [RDS Naming Constraints][5]
  • port (pulumi.Input[float]) – The port on which the DB accepts connections
  • preferred_backup_window (pulumi.Input[str]) – 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
  • preferred_maintenance_window (pulumi.Input[str]) – The weekly time range during which system maintenance can occur, in (UTC) e.g. wed:04:00-wed:04:30
  • replication_source_identifier (pulumi.Input[str]) – ARN of a source DB cluster or DB instance if this DB cluster is to be created as a Read Replica.
  • scaling_configuration (pulumi.Input[dict]) – Nested attribute with scaling properties. Only valid when engine_mode is set to serverless. More details below.
  • skip_final_snapshot (pulumi.Input[bool]) – 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 final_snapshot_identifier. Default is false.
  • snapshot_identifier (pulumi.Input[str]) – 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.
  • source_region (pulumi.Input[str]) – The source region for an encrypted replica DB cluster.
  • storage_encrypted (pulumi.Input[bool]) – Specifies whether the DB cluster is encrypted. The default is false for provisioned engine_mode and true for serverless engine_mode.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the DB cluster.
  • vpc_security_group_ids (pulumi.Input[list]) – List of VPC security groups to associate with the Cluster
apply_immediately = None

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

arn = None

Amazon Resource Name (ARN) of cluster

availability_zones = None

A list of EC2 Availability Zones that instances in the DB cluster can be created in

backtrack_window = None

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)

backup_retention_period = None

The days to retain backups for. Default 1

cluster_identifier = None

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

cluster_identifier_prefix = None

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

cluster_members = None

List of RDS Instances that are a part of this cluster

cluster_resource_id = None

The RDS Cluster Resource ID

database_name = None

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

db_cluster_parameter_group_name = None

A cluster parameter group to associate with the cluster.

db_subnet_group_name = None

A DB subnet group to associate with this DB instance. NOTE: This must match the db_subnet_group_name specified on every ``aws_rds_cluster_instance` <https://www.terraform.io/docs/providers/aws/r/rds_cluster_instance.html>`_ in the cluster.

deletion_protection = None

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.

enabled_cloudwatch_logs_exports = None

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.

endpoint = None

The DNS address of the RDS instance

engine = None

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

engine_mode = None

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

engine_version = None

The database engine version. Updating this argument results in an outage.

final_snapshot_identifier = None

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

global_cluster_identifier = None

The global cluster identifier specified on ``aws_rds_global_cluster` <https://www.terraform.io/docs/providers/aws/r/rds_global_cluster.html>`_.

hosted_zone_id = None

The Route53 Hosted Zone ID of the endpoint

iam_database_authentication_enabled = None

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.

iam_roles = None

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

kms_key_id = None

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

master_password = None

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

master_username = None

Username for the master DB user. Please refer to the [RDS Naming Constraints][5]

port = None

The port on which the DB accepts connections

preferred_backup_window = None

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

preferred_maintenance_window = None

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

reader_endpoint = None

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

replication_source_identifier = None

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

scaling_configuration = None

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

skip_final_snapshot = None

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

snapshot_identifier = None

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.

source_region = None

The source region for an encrypted replica DB cluster.

storage_encrypted = None

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

tags = None

A mapping of tags to assign to the DB cluster.

vpc_security_group_ids = None

List of VPC security groups to associate with the Cluster

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.rds.ClusterEndpoint(resource_name, opts=None, cluster_endpoint_identifier=None, cluster_identifier=None, custom_endpoint_type=None, excluded_members=None, static_members=None, __name__=None, __opts__=None)

Manages a RDS Aurora Cluster Endpoint. You can refer to the [User Guide][1].

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • cluster_endpoint_identifier (pulumi.Input[str]) – The identifier to use for the new endpoint. This parameter is stored as a lowercase string.
  • cluster_identifier (pulumi.Input[str]) – The cluster identifier.
  • custom_endpoint_type (pulumi.Input[str]) – The type of the endpoint. One of: READER , ANY .
  • excluded_members (pulumi.Input[list]) – 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 static_members.
  • static_members (pulumi.Input[list]) – List of DB instance identifiers that are part of the custom endpoint group. Conflicts with excluded_members.
arn = None

Amazon Resource Name (ARN) of cluster

cluster_endpoint_identifier = None

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

cluster_identifier = None

The cluster identifier.

custom_endpoint_type = None

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

endpoint = None

A custom endpoint for the Aurora cluster

excluded_members = None

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 static_members.

static_members = None

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

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.rds.ClusterInstance(resource_name, opts=None, apply_immediately=None, auto_minor_version_upgrade=None, availability_zone=None, cluster_identifier=None, copy_tags_to_snapshot=None, db_parameter_group_name=None, db_subnet_group_name=None, engine=None, engine_version=None, identifier=None, identifier_prefix=None, instance_class=None, monitoring_interval=None, monitoring_role_arn=None, performance_insights_enabled=None, performance_insights_kms_key_id=None, preferred_backup_window=None, preferred_maintenance_window=None, promotion_tier=None, publicly_accessible=None, tags=None, __name__=None, __opts__=None)

Provides an RDS Cluster Resource Instance. A Cluster Instance Resource defines attributes that are specific to a single instance in a [RDS Cluster][3], specifically running Amazon Aurora.

Unlike other RDS resources that support replication, with Amazon Aurora you do not designate a primary and subsequent replicas. Instead, you simply add RDS Instances and Aurora manages the replication. You can use the [count][5] meta-parameter to make multiple instances and join them all to the same RDS Cluster, or you may specify different Cluster Instance resources with various instance_class sizes.

For more information on Amazon Aurora, see [Aurora on Amazon RDS][2] 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 ``prevent_destroy` lifecycle behavior <https://www.terraform.io/docs/configuration/resources.html#prevent_destroy>`_ to your Terraform resource configuration if you desire protection from accidental deletion.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • apply_immediately (pulumi.Input[bool]) – Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default isfalse.
  • auto_minor_version_upgrade (pulumi.Input[bool]) – Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default true.
  • availability_zone (pulumi.Input[str]) – The EC2 Availability Zone that the DB instance is created in. See docs about the details.
  • cluster_identifier (pulumi.Input[str]) – The identifier of the ``aws_rds_cluster` <https://www.terraform.io/docs/providers/aws/r/rds_cluster.html>`_ in which to launch this instance.
  • copy_tags_to_snapshot (pulumi.Input[bool]) – Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance. Default false.
  • db_parameter_group_name (pulumi.Input[str]) – The name of the DB parameter group to associate with this instance.
  • db_subnet_group_name (pulumi.Input[str]) – A DB subnet group to associate with this DB instance. NOTE: This must match the db_subnet_group_name of the attached ``aws_rds_cluster` <https://www.terraform.io/docs/providers/aws/r/rds_cluster.html>`_.
  • engine (pulumi.Input[str]) –

    The name of the database engine to be used for the RDS instance. Defaults to aurora. Valid Values: aurora, aurora-mysql, aurora-postgresql. For information on the difference between the available Aurora MySQL engines see Comparison between Aurora MySQL 1 and Aurora MySQL 2 in the Amazon RDS User Guide.

  • engine_version (pulumi.Input[str]) – The database engine version.
  • identifier (pulumi.Input[str]) – The indentifier for the RDS instance, if omitted, Terraform will assign a random, unique identifier.
  • identifier_prefix (pulumi.Input[str]) – Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
  • instance_class (pulumi.Input[str]) – The instance class to use. For details on CPU and memory, see [Scaling Aurora DB Instances][4]. Aurora currently supports the below instance classes. Please see [AWS Documentation][7] for complete details.
Parameters:
  • monitoring_interval (pulumi.Input[float]) – The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
  • monitoring_role_arn (pulumi.Input[str]) –

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

  • performance_insights_enabled (pulumi.Input[bool]) – Specifies whether Performance Insights is enabled or not.
  • performance_insights_kms_key_id (pulumi.Input[str]) – The ARN for the KMS key to encrypt Performance Insights data. When specifying performance_insights_kms_key_id, performance_insights_enabled needs to be set to true.
  • preferred_backup_window (pulumi.Input[str]) – The daily time range during which automated backups are created if automated backups are enabled. Eg: “04:00-09:00”
  • preferred_maintenance_window (pulumi.Input[str]) – The window to perform maintenance in. Syntax: “ddd:hh24:mi-ddd:hh24:mi”. Eg: “Mon:00:00-Mon:03:00”.
  • promotion_tier (pulumi.Input[float]) – Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoter to writer.
  • publicly_accessible (pulumi.Input[bool]) – Bool to control if instance is publicly accessible. Default false. See the documentation on [Creating DB Instances][6] for more details on controlling this property.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the instance.
apply_immediately = None

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

arn = None

Amazon Resource Name (ARN) of cluster instance

auto_minor_version_upgrade = None

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

availability_zone = None

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

cluster_identifier = None

The identifier of the ``aws_rds_cluster` <https://www.terraform.io/docs/providers/aws/r/rds_cluster.html>`_ in which to launch this instance.

copy_tags_to_snapshot = None

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

db_parameter_group_name = None

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

db_subnet_group_name = None

A DB subnet group to associate with this DB instance. NOTE: This must match the db_subnet_group_name of the attached ``aws_rds_cluster` <https://www.terraform.io/docs/providers/aws/r/rds_cluster.html>`_.

dbi_resource_id = None

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

endpoint = None

The DNS address for this instance. May not be writable

engine = None

The name of the database engine to be used for the RDS instance. Defaults to aurora. Valid Values: aurora, aurora-mysql, aurora-postgresql. For information on the difference between the available Aurora MySQL engines see Comparison between Aurora MySQL 1 and Aurora MySQL 2 in the Amazon RDS User Guide.

engine_version = None

The database engine version.

identifier = None

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

identifier_prefix = None

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

instance_class = None

The instance class to use. For details on CPU and memory, see [Scaling Aurora DB Instances][4]. Aurora currently supports the below instance classes. Please see [AWS Documentation][7] for complete details.

  • db.t2.small
  • db.t2.medium
  • 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
kms_key_id = None

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

monitoring_interval = None

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.

monitoring_role_arn = None

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

performance_insights_enabled = None

Specifies whether Performance Insights is enabled or not.

performance_insights_kms_key_id = None

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

port = None

The database port

preferred_backup_window = None

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

preferred_maintenance_window = None

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

promotion_tier = None

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

publicly_accessible = None

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

storage_encrypted = None

Specifies whether the DB cluster is encrypted.

tags = None

A mapping of tags to assign to the instance.

writer = None

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

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.rds.ClusterParameterGroup(resource_name, opts=None, description=None, family=None, name=None, name_prefix=None, parameters=None, tags=None, __name__=None, __opts__=None)

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

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • description (pulumi.Input[str]) – The description of the DB cluster parameter group. Defaults to “Managed by Terraform”.
  • family (pulumi.Input[str]) – The family of the DB cluster parameter group.
  • name (pulumi.Input[str]) – The name of the DB parameter.
  • name_prefix (pulumi.Input[str]) – Creates a unique name beginning with the specified prefix. Conflicts with name.
  • parameters (pulumi.Input[list]) – 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` <https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-cluster-parameters.html>`_ after initial creation of the group.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
arn = None

The ARN of the db cluster parameter group.

description = None

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

family = None

The family of the DB cluster parameter group.

name = None

The name of the DB parameter.

name_prefix = None

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

parameters = None

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` <https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-cluster-parameters.html>`_ after initial creation of the group.

tags = None

A mapping of tags to assign to the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.rds.ClusterSnapshot(resource_name, opts=None, db_cluster_identifier=None, db_cluster_snapshot_identifier=None, __name__=None, __opts__=None)

Manages a RDS database cluster snapshot for Aurora clusters. For managing RDS database instance snapshots, see the ``aws_db_snapshot` resource <https://www.terraform.io/docs/providers/aws/r/db_snapshot.html>`_.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • db_cluster_identifier (pulumi.Input[str]) – The DB Cluster Identifier from which to take the snapshot.
  • db_cluster_snapshot_identifier (pulumi.Input[str]) – The Identifier for the snapshot.
allocated_storage = None

Specifies the allocated storage size in gigabytes (GB).

availability_zones = None

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

db_cluster_identifier = None

The DB Cluster Identifier from which to take the snapshot.

db_cluster_snapshot_arn = None

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

db_cluster_snapshot_identifier = None

The Identifier for the snapshot.

engine = None

Specifies the name of the database engine.

engine_version = None

Version of the database engine for this DB cluster snapshot.

kms_key_id = None

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

license_model = None

License model information for the restored DB cluster.

port = None

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

status = None

The status of this DB Cluster Snapshot.

storage_encrypted = None

Specifies whether the DB cluster snapshot is encrypted.

vpc_id = None

The VPC ID associated with the DB cluster snapshot.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.rds.EventSubscription(resource_name, opts=None, enabled=None, event_categories=None, name=None, name_prefix=None, sns_topic=None, source_ids=None, source_type=None, tags=None, __name__=None, __opts__=None)

Provides a DB event subscription resource.

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
  • customer_aws_id - The AWS customer account associated with the RDS event notification subscription
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • enabled (pulumi.Input[bool]) – A boolean flag to enable/disable the subscription. Defaults to true.
  • event_categories (pulumi.Input[list]) – 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.
  • name (pulumi.Input[str]) – The name of the DB event subscription. By default generated by Terraform.
  • name_prefix (pulumi.Input[str]) – The name of the DB event subscription. Conflicts with name.
  • sns_topic (pulumi.Input[str]) – The SNS topic to send events to.
  • source_ids (pulumi.Input[list]) – 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 source_type must also be specified.
  • source_type (pulumi.Input[str]) – 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.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
enabled = None

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

event_categories = None

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.

name = None

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

name_prefix = None

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

sns_topic = None

The SNS topic to send events to.

source_ids = None

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 source_type must also be specified.

source_type = None

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.

tags = None

A mapping of tags to assign to the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.rds.GetClusterResult(arn=None, availability_zones=None, backup_retention_period=None, cluster_members=None, cluster_resource_id=None, database_name=None, db_cluster_parameter_group_name=None, db_subnet_group_name=None, enabled_cloudwatch_logs_exports=None, endpoint=None, engine=None, engine_version=None, final_snapshot_identifier=None, iam_database_authentication_enabled=None, iam_roles=None, kms_key_id=None, master_username=None, port=None, preferred_backup_window=None, preferred_maintenance_window=None, reader_endpoint=None, replication_source_identifier=None, storage_encrypted=None, tags=None, vpc_security_group_ids=None, id=None)

A collection of values returned by getCluster.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_aws.rds.GetClusterSnapshotResult(allocated_storage=None, availability_zones=None, db_cluster_snapshot_arn=None, engine=None, engine_version=None, kms_key_id=None, license_model=None, port=None, snapshot_create_time=None, source_db_cluster_snapshot_arn=None, status=None, storage_encrypted=None, vpc_id=None, id=None)

A collection of values returned by getClusterSnapshot.

allocated_storage = None

Specifies the allocated storage size in gigabytes (GB).

availability_zones = None

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

db_cluster_snapshot_arn = None

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

engine = None

Specifies the name of the database engine.

engine_version = None

Version of the database engine for this DB cluster snapshot.

kms_key_id = None

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

license_model = None

License model information for the restored DB cluster.

port = None

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

snapshot_create_time = None

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

status = None

The status of this DB Cluster Snapshot.

storage_encrypted = None

Specifies whether the DB cluster snapshot is encrypted.

vpc_id = None

The VPC ID associated with the DB cluster snapshot.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_aws.rds.GetEventCategoriesResult(event_categories=None, id=None)

A collection of values returned by getEventCategories.

event_categories = None

A list of the event categories.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_aws.rds.GetInstanceResult(address=None, allocated_storage=None, auto_minor_version_upgrade=None, availability_zone=None, backup_retention_period=None, ca_cert_identifier=None, db_cluster_identifier=None, db_instance_arn=None, db_instance_class=None, db_instance_port=None, db_name=None, db_parameter_groups=None, db_security_groups=None, db_subnet_group=None, enabled_cloudwatch_logs_exports=None, endpoint=None, engine=None, engine_version=None, hosted_zone_id=None, iops=None, kms_key_id=None, license_model=None, master_username=None, monitoring_interval=None, monitoring_role_arn=None, multi_az=None, option_group_memberships=None, port=None, preferred_backup_window=None, preferred_maintenance_window=None, publicly_accessible=None, replicate_source_db=None, storage_encrypted=None, storage_type=None, timezone=None, vpc_security_groups=None, id=None)

A collection of values returned by getInstance.

address = None

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

allocated_storage = None

Specifies the allocated storage size specified in gigabytes.

auto_minor_version_upgrade = None

Indicates that minor version patches are applied automatically.

availability_zone = None

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

backup_retention_period = None

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

ca_cert_identifier = None

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

db_cluster_identifier = None

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.

db_instance_arn = None

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

db_instance_class = None

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

db_instance_port = None

Specifies the port that the DB instance listens on.

db_name = None

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.

db_parameter_groups = None

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

db_security_groups = None

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

db_subnet_group = None

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

enabled_cloudwatch_logs_exports = None

List of log types to export to cloudwatch.

endpoint = None

The connection endpoint in address:port format.

engine = None

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

engine_version = None

Indicates the database engine version.

hosted_zone_id = None

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

iops = None

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

kms_key_id = None

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

license_model = None

License model information for this DB instance.

master_username = None

Contains the master username for the DB instance.

monitoring_interval = None

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

monitoring_role_arn = None

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

multi_az = None

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

option_group_memberships = None

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

port = None

The database port.

preferred_backup_window = None

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

preferred_maintenance_window = None

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

publicly_accessible = None

Specifies the accessibility options for the DB instance.

replicate_source_db = None

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

storage_encrypted = None

Specifies whether the DB instance is encrypted.

storage_type = None

Specifies the storage type associated with DB instance.

timezone = None

The time zone of the DB instance.

vpc_security_groups = None

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

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_aws.rds.GetSnapshotResult(allocated_storage=None, availability_zone=None, db_snapshot_arn=None, encrypted=None, engine=None, engine_version=None, iops=None, kms_key_id=None, license_model=None, option_group_name=None, port=None, snapshot_create_time=None, source_db_snapshot_identifier=None, source_region=None, status=None, storage_type=None, vpc_id=None, id=None)

A collection of values returned by getSnapshot.

allocated_storage = None

Specifies the allocated storage size in gigabytes (GB).

availability_zone = None

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

db_snapshot_arn = None

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

encrypted = None

Specifies whether the DB snapshot is encrypted.

engine = None

Specifies the name of the database engine.

engine_version = None

Specifies the version of the database engine.

iops = None

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

kms_key_id = None

The ARN for the KMS encryption key.

license_model = None

License model information for the restored DB instance.

option_group_name = None

Provides the option group name for the DB snapshot.

snapshot_create_time = None

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

source_db_snapshot_identifier = None

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

source_region = None

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

status = None

Specifies the status of this DB snapshot.

storage_type = None

Specifies the storage type associated with DB snapshot.

vpc_id = None

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

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_aws.rds.GlobalCluster(resource_name, opts=None, database_name=None, deletion_protection=None, engine=None, engine_version=None, global_cluster_identifier=None, storage_encrypted=None, __name__=None, __opts__=None)

Manages a 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.

NOTE: RDS only supports the aurora engine (MySQL 5.6 compatible) for Global Clusters at this time.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • database_name (pulumi.Input[str]) – Name for an automatically created database on cluster creation.
  • deletion_protection (pulumi.Input[bool]) – 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.
  • engine (pulumi.Input[str]) – Name of the database engine to be used for this DB cluster. Valid values: aurora. Defaults to aurora.
  • engine_version (pulumi.Input[str]) – Engine version of the Aurora global database.
  • storage_encrypted (pulumi.Input[bool]) – Specifies whether the DB cluster is encrypted. The default is false.
arn = None

RDS Global Cluster Amazon Resource Name (ARN)

database_name = None

Name for an automatically created database on cluster creation.

deletion_protection = None

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.

engine = None

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

engine_version = None

Engine version of the Aurora global database.

global_cluster_resource_id = None

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

storage_encrypted = None

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

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.rds.Instance(resource_name, opts=None, allocated_storage=None, allow_major_version_upgrade=None, apply_immediately=None, auto_minor_version_upgrade=None, availability_zone=None, backup_retention_period=None, backup_window=None, character_set_name=None, copy_tags_to_snapshot=None, db_subnet_group_name=None, deletion_protection=None, domain=None, domain_iam_role_name=None, enabled_cloudwatch_logs_exports=None, engine=None, engine_version=None, final_snapshot_identifier=None, iam_database_authentication_enabled=None, identifier=None, identifier_prefix=None, instance_class=None, iops=None, kms_key_id=None, license_model=None, maintenance_window=None, monitoring_interval=None, monitoring_role_arn=None, multi_az=None, name=None, option_group_name=None, parameter_group_name=None, password=None, port=None, publicly_accessible=None, replicate_source_db=None, s3_import=None, security_group_names=None, skip_final_snapshot=None, snapshot_identifier=None, storage_encrypted=None, storage_type=None, tags=None, timezone=None, username=None, vpc_security_group_ids=None, __name__=None, __opts__=None)

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

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

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

Note: using apply_immediately can result in a brief downtime as the server reboots. See the AWS Docs on [RDS Maintenance][2] for more information.

Note: All arguments including the username and password will be stored in the raw state as plain-text. Read more about sensitive data in state.

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

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • allocated_storage (pulumi.Input[float]) – (Required unless a snapshot_identifier or replicate_source_db is provided) The allocated storage in gibibytes.
  • allow_major_version_upgrade (pulumi.Input[bool]) – Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
  • apply_immediately (pulumi.Input[bool]) –

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

  • auto_minor_version_upgrade (pulumi.Input[bool]) – Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaults to true.
  • availability_zone (pulumi.Input[str]) – The AZ for the RDS instance.
  • backup_retention_period (pulumi.Input[float]) – The days to retain backups for. Must be between 0 and 35. When creating a Read Replica the value must be greater than 0. [See Read Replica][1].
  • backup_window (pulumi.Input[str]) – The daily time range (in UTC) during which automated backups are created if they are enabled. Example: “09:46-10:16”. Must not overlap with maintenance_window.
  • character_set_name (pulumi.Input[str]) – The character set name to use for DB encoding in Oracle instances. This can’t be changed. See Oracle Character Sets Supported in Amazon RDS for more information.
  • copy_tags_to_snapshot (pulumi.Input[bool]) – Copy all Instance tags to snapshots. Default is false.
  • db_subnet_group_name (pulumi.Input[str]) – Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC, or in EC2 Classic, if available. When working with read replicas, it needs to 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.
  • deletion_protection (pulumi.Input[bool]) – If the DB instance should have deletion protection enabled. The database can’t be deleted when this value is set to true. The default is false.
  • domain (pulumi.Input[str]) – The ID of the Directory Service Active Directory domain to create the instance in.
  • domain_iam_role_name (pulumi.Input[str]) – The name of the IAM role to be used when making API calls to the Directory Service.
  • enabled_cloudwatch_logs_exports (pulumi.Input[list]) – List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL).
  • engine (pulumi.Input[str]) –

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

  • engine_version (pulumi.Input[str]) –

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

  • final_snapshot_identifier (pulumi.Input[str]) – The name of your final DB snapshot when this DB instance is deleted. If omitted, no final snapshot will be made.
  • iam_database_authentication_enabled (pulumi.Input[bool]) – Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.
  • identifier (pulumi.Input[str]) – The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier.
  • identifier_prefix (pulumi.Input[str]) – Creates a unique identifier beginning with the specified prefix. Conflicts with identifier.
  • instance_class (pulumi.Input[str]) – The instance type of the RDS instance.
  • iops (pulumi.Input[float]) – The amount of provisioned IOPS. Setting this implies a storage_type of “io1”.
  • kms_key_id (pulumi.Input[str]) – The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN.
  • license_model (pulumi.Input[str]) – (Optional, but required for some DB engines, i.e. Oracle SE1) License model information for this DB instance.
  • maintenance_window (pulumi.Input[str]) – The window to perform maintenance in. Syntax: “ddd:hh24:mi-ddd:hh24:mi”. Eg: “Mon:00:00-Mon:03:00”. See RDS Maintenance Window docs for more information.
  • monitoring_interval (pulumi.Input[float]) – The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
  • monitoring_role_arn (pulumi.Input[str]) –

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

  • multi_az (pulumi.Input[bool]) – Specifies if the RDS instance is multi-AZ
  • name (pulumi.Input[str]) –

    The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Note that this does not apply for Oracle or SQL Server engines. See the AWS documentation for more details on what applies for those engines.

  • option_group_name (pulumi.Input[str]) – Name of the DB option group to associate.
  • parameter_group_name (pulumi.Input[str]) – Name of the DB parameter group to associate.
  • password (pulumi.Input[str]) – (Required unless a snapshot_identifier or replicate_source_db is provided) Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file.
  • port (pulumi.Input[float]) – The port on which the DB accepts connections.
  • publicly_accessible (pulumi.Input[bool]) – Bool to control if instance is publicly accessible. Default is false.
  • replicate_source_db (pulumi.Input[str]) – Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. Note that if you are creating a cross-region replica of an encrypted database you will also need to specify a kms_key_id. See [DB Instance Replication][1] and Working with PostgreSQL and MySQL Read Replicas for more information on using Replication.
  • s3_import (pulumi.Input[dict]) – Restore from a Percona Xtrabackup in S3. See Importing Data into an Amazon RDS MySQL DB Instance
  • security_group_names (pulumi.Input[list]) – List of DB Security Groups to associate. Only used for DB Instances on the *EC2-Classic* Platform.
  • skip_final_snapshot (pulumi.Input[bool]) – Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier. Default is false.
  • snapshot_identifier (pulumi.Input[str]) – Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you’d find in the RDS console, e.g: rds:production-2015-06-26-06-05.
  • storage_encrypted (pulumi.Input[bool]) – Specifies whether the DB instance is encrypted. Note that if you are creating a cross-region read replica this field is ignored and you should instead declare kms_key_id with a valid ARN. The default is false if not specified.
  • storage_type (pulumi.Input[str]) – One of “standard” (magnetic), “gp2” (general purpose SSD), or “io1” (provisioned IOPS SSD). The default is “io1” if iops is specified, “standard” if not. Note that this behaviour is different from the AWS web console, where the default is “gp2”.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
  • timezone (pulumi.Input[str]) – Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information.
  • username (pulumi.Input[str]) – (Required unless a snapshot_identifier or replicate_source_db is provided) Username for the master DB user.
  • vpc_security_group_ids (pulumi.Input[list]) – List of VPC security groups to associate.
address = None

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

allocated_storage = None

(Required unless a snapshot_identifier or replicate_source_db is provided) The allocated storage in gibibytes.

allow_major_version_upgrade = None

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

apply_immediately = None

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

arn = None

The ARN of the RDS instance.

auto_minor_version_upgrade = None

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

availability_zone = None

The AZ for the RDS instance.

backup_retention_period = None

The days to retain backups for. Must be between 0 and 35. When creating a Read Replica the value must be greater than 0. [See Read Replica][1].

backup_window = None

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

ca_cert_identifier = None

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

character_set_name = None

The character set name to use for DB encoding in Oracle instances. This can’t be changed. See Oracle Character Sets Supported in Amazon RDS for more information.

copy_tags_to_snapshot = None

Copy all Instance tags to snapshots. Default is false.

db_subnet_group_name = None

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 needs to 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.

deletion_protection = None

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

domain = None

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

domain_iam_role_name = None

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

enabled_cloudwatch_logs_exports = None

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

endpoint = None

The connection endpoint in address:port format.

engine = None

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

engine_version = None

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

final_snapshot_identifier = None

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

hosted_zone_id = None

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

iam_database_authentication_enabled = None

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

identifier = None

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

identifier_prefix = None

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

instance_class = None

The instance type of the RDS instance.

iops = None

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

kms_key_id = None

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

license_model = None

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

maintenance_window = None

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.

monitoring_interval = None

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.

monitoring_role_arn = None

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

multi_az = None

Specifies if the RDS instance is multi-AZ

name = None

The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Note that this does not apply for Oracle or SQL Server engines. See the AWS documentation for more details on what applies for those engines.

option_group_name = None

Name of the DB option group to associate.

parameter_group_name = None

Name of the DB parameter group to associate.

password = None

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

port = None

The port on which the DB accepts connections.

publicly_accessible = None

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

replicate_source_db = None

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. Note that if you are creating a cross-region replica of an encrypted database you will also need to specify a kms_key_id. See [DB Instance Replication][1] and Working with PostgreSQL and MySQL Read Replicas for more information on using Replication.

resource_id = None

The RDS Resource ID of this instance.

s3_import = None

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

security_group_names = None

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

skip_final_snapshot = None

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

snapshot_identifier = None

Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you’d find in the RDS console, e.g: rds:production-2015-06-26-06-05.

status = None

The RDS instance status.

storage_encrypted = None

Specifies whether the DB instance is encrypted. Note that if you are creating a cross-region read replica this field is ignored and you should instead declare kms_key_id with a valid ARN. The default is false if not specified.

storage_type = None

One of “standard” (magnetic), “gp2” (general purpose SSD), or “io1” (provisioned IOPS SSD). The default is “io1” if iops is specified, “standard” if not. Note that this behaviour is different from the AWS web console, where the default is “gp2”.

tags = None

A mapping of tags to assign to the resource.

timezone = None

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

username = None

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

vpc_security_group_ids = None

List of VPC security groups to associate.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.rds.OptionGroup(resource_name, opts=None, engine_name=None, major_engine_version=None, name=None, name_prefix=None, options=None, option_group_description=None, tags=None, __name__=None, __opts__=None)

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

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • engine_name (pulumi.Input[str]) – Specifies the name of the engine that this option group should be associated with.
  • major_engine_version (pulumi.Input[str]) – Specifies the major version of the engine that this option group should be associated with.
  • name (pulumi.Input[str]) – The Name of the setting.
  • name_prefix (pulumi.Input[str]) – Creates a unique name beginning with the specified prefix. Conflicts with name. Must be lowercase, to match as it is stored in AWS.
  • options (pulumi.Input[list]) – A list of Options to apply.
  • option_group_description (pulumi.Input[str]) – The description of the option group. Defaults to “Managed by Terraform”.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
arn = None

The ARN of the db option group.

engine_name = None

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

major_engine_version = None

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

name = None

The Name of the setting.

name_prefix = None

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

options = None

A list of Options to apply.

option_group_description = None

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

tags = None

A mapping of tags to assign to the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.rds.ParameterGroup(resource_name, opts=None, description=None, family=None, name=None, name_prefix=None, parameters=None, tags=None, __name__=None, __opts__=None)

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

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • description (pulumi.Input[str]) – The description of the DB parameter group. Defaults to “Managed by Terraform”.
  • family (pulumi.Input[str]) – The family of the DB parameter group.
  • name (pulumi.Input[str]) – The name of the DB parameter.
  • name_prefix (pulumi.Input[str]) – Creates a unique name beginning with the specified prefix. Conflicts with name.
  • parameters (pulumi.Input[list]) – 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` <https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-parameters.html>`_ after initial creation of the group.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
arn = None

The ARN of the db parameter group.

description = None

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

family = None

The family of the DB parameter group.

name = None

The name of the DB parameter.

name_prefix = None

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

parameters = None

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` <https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-parameters.html>`_ after initial creation of the group.

tags = None

A mapping of tags to assign to the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.rds.SecurityGroup(resource_name, opts=None, description=None, ingress=None, name=None, tags=None, __name__=None, __opts__=None)

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` <https://www.terraform.io/docs/providers/aws/r/db_instance.html#vpc_security_group_ids>`_ attribute instead.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • description (pulumi.Input[str]) – The description of the DB security group. Defaults to “Managed by Terraform”.
  • ingress (pulumi.Input[list]) – A list of ingress rules.
  • name (pulumi.Input[str]) – The name of the DB security group.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
arn = None

The arn of the DB security group.

description = None

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

ingress = None

A list of ingress rules.

name = None

The name of the DB security group.

tags = None

A mapping of tags to assign to the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.rds.Snapshot(resource_name, opts=None, db_instance_identifier=None, db_snapshot_identifier=None, tags=None, __name__=None, __opts__=None)

Manages a RDS database instance snapshot. For managing RDS database cluster snapshots, see the ``aws_db_cluster_snapshot` resource <https://www.terraform.io/docs/providers/aws/r/db_cluster_snapshot.html>`_.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • db_instance_identifier (pulumi.Input[str]) – The DB Instance Identifier from which to take the snapshot.
  • db_snapshot_identifier (pulumi.Input[str]) – The Identifier for the snapshot.
  • tags (pulumi.Input[dict]) – Key-value mapping of resource tags
allocated_storage = None

Specifies the allocated storage size in gigabytes (GB).

availability_zone = None

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

db_instance_identifier = None

The DB Instance Identifier from which to take the snapshot.

db_snapshot_arn = None

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

db_snapshot_identifier = None

The Identifier for the snapshot.

encrypted = None

Specifies whether the DB snapshot is encrypted.

engine = None

Specifies the name of the database engine.

engine_version = None

Specifies the version of the database engine.

iops = None

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

kms_key_id = None

The ARN for the KMS encryption key.

license_model = None

License model information for the restored DB instance.

option_group_name = None

Provides the option group name for the DB snapshot.

source_db_snapshot_identifier = None

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

source_region = None

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

status = None

Specifies the status of this DB snapshot.

storage_type = None

Specifies the storage type associated with DB snapshot.

tags = None

Key-value mapping of resource tags

vpc_id = None

Specifies the storage type associated with DB snapshot.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.rds.SubnetGroup(resource_name, opts=None, description=None, name=None, name_prefix=None, subnet_ids=None, tags=None, __name__=None, __opts__=None)

Provides an RDS DB subnet group resource.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • description (pulumi.Input[str]) – The description of the DB subnet group. Defaults to “Managed by Terraform”.
  • name (pulumi.Input[str]) – The name of the DB subnet group. If omitted, Terraform will assign a random, unique name.
  • name_prefix (pulumi.Input[str]) – Creates a unique name beginning with the specified prefix. Conflicts with name.
  • subnet_ids (pulumi.Input[list]) – A list of VPC subnet IDs.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
arn = None

The ARN of the db subnet group.

description = None

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

name = None

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

name_prefix = None

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

subnet_ids = None

A list of VPC subnet IDs.

tags = None

A mapping of tags to assign to the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
pulumi_aws.rds.get_cluster(cluster_identifier=None, tags=None, opts=None)

Provides information about a RDS cluster.

pulumi_aws.rds.get_cluster_snapshot(db_cluster_identifier=None, db_cluster_snapshot_identifier=None, include_public=None, include_shared=None, most_recent=None, snapshot_type=None, opts=None)

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_db_snapshot` data source <https://www.terraform.io/docs/providers/aws/d/db_snapshot.html>`_ for DB Instance snapshots.
pulumi_aws.rds.get_instance(db_instance_identifier=None, opts=None)

Use this data source to get information about an RDS instance

pulumi_aws.rds.get_snapshot(db_instance_identifier=None, db_snapshot_identifier=None, include_public=None, include_shared=None, most_recent=None, snapshot_type=None, opts=None)

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_db_cluster_snapshot` data source <https://www.terraform.io/docs/providers/aws/d/db_cluster_snapshot.html>`_ for DB Cluster snapshots.