rds

package
v0.18.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 5, 2019 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Cluster 

type Cluster struct {
	// contains filtered or unexported fields
}

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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AuroraMySQL.Updates.20180206.html) 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](https://www.terraform.io/docs/state/sensitive-data.html).

func GetCluster 

func GetCluster(ctx *pulumi.Context,
	name string, id pulumi.ID, state *ClusterState, opts ...pulumi.ResourceOpt) (*Cluster, error)

GetCluster gets an existing Cluster resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewCluster 

func NewCluster(ctx *pulumi.Context,
	name string, args *ClusterArgs, opts ...pulumi.ResourceOpt) (*Cluster, error)

NewCluster registers a new resource with the given unique name, arguments, and options.

func (*Cluster) ApplyImmediately 

func (r *Cluster) ApplyImmediately() *pulumi.BoolOutput

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is `false`. See [Amazon RDS Documentation for more information.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html)

func (*Cluster) Arn added in v0.15.1 

func (r *Cluster) Arn() *pulumi.StringOutput

Amazon Resource Name (ARN) of cluster

func (*Cluster) AvailabilityZones 

func (r *Cluster) AvailabilityZones() *pulumi.ArrayOutput

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

func (*Cluster) BacktrackWindow 

func (r *Cluster) BacktrackWindow() *pulumi.IntOutput

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)

func (*Cluster) BackupRetentionPeriod 

func (r *Cluster) BackupRetentionPeriod() *pulumi.IntOutput

The days to retain backups for. Default `1`

func (*Cluster) ClusterIdentifier 

func (r *Cluster) ClusterIdentifier() *pulumi.StringOutput

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

func (*Cluster) ClusterIdentifierPrefix 

func (r *Cluster) ClusterIdentifierPrefix() *pulumi.StringOutput

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

func (*Cluster) ClusterMembers 

func (r *Cluster) ClusterMembers() *pulumi.ArrayOutput

List of RDS Instances that are a part of this cluster

func (*Cluster) ClusterResourceId 

func (r *Cluster) ClusterResourceId() *pulumi.StringOutput

The RDS Cluster Resource ID

func (*Cluster) DatabaseName 

func (r *Cluster) DatabaseName() *pulumi.StringOutput

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

func (*Cluster) DbClusterParameterGroupName 

func (r *Cluster) DbClusterParameterGroupName() *pulumi.StringOutput

A cluster parameter group to associate with the cluster.

func (*Cluster) DbSubnetGroupName 

func (r *Cluster) DbSubnetGroupName() *pulumi.StringOutput

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.

func (*Cluster) DeletionProtection added in v0.16.1 

func (r *Cluster) DeletionProtection() *pulumi.BoolOutput

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

func (*Cluster) EnabledCloudwatchLogsExports added in v0.14.1 

func (r *Cluster) EnabledCloudwatchLogsExports() *pulumi.ArrayOutput

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

func (*Cluster) Endpoint 

func (r *Cluster) Endpoint() *pulumi.StringOutput

The DNS address of the RDS instance

func (*Cluster) Engine 

func (r *Cluster) Engine() *pulumi.StringOutput

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

func (*Cluster) EngineMode added in v0.15.1 

func (r *Cluster) EngineMode() *pulumi.StringOutput

The database engine mode. Valid values: `global`, `parallelquery`, `provisioned`, `serverless`. Defaults to: `provisioned`. See the [RDS User Guide](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/aurora-serverless.html) for limitations when using `serverless`.

func (*Cluster) EngineVersion 

func (r *Cluster) EngineVersion() *pulumi.StringOutput

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

func (*Cluster) FinalSnapshotIdentifier 

func (r *Cluster) FinalSnapshotIdentifier() *pulumi.StringOutput

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

func (*Cluster) GlobalClusterIdentifier added in v0.16.5 

func (r *Cluster) GlobalClusterIdentifier() *pulumi.StringOutput

The global cluster identifier specified on [`aws_rds_global_cluster`](https://www.terraform.io/docs/providers/aws/r/rds_global_cluster.html).

func (*Cluster) HostedZoneId 

func (r *Cluster) HostedZoneId() *pulumi.StringOutput

The Route53 Hosted Zone ID of the endpoint

func (*Cluster) ID 

func (r *Cluster) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*Cluster) IamDatabaseAuthenticationEnabled 

func (r *Cluster) IamDatabaseAuthenticationEnabled() *pulumi.BoolOutput

Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Please see [AWS Documentation](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) for availability and limitations.

func (*Cluster) IamRoles 

func (r *Cluster) IamRoles() *pulumi.ArrayOutput

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

func (*Cluster) KmsKeyId 

func (r *Cluster) KmsKeyId() *pulumi.StringOutput

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

func (*Cluster) MasterPassword 

func (r *Cluster) MasterPassword() *pulumi.StringOutput

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]

func (*Cluster) MasterUsername 

func (r *Cluster) MasterUsername() *pulumi.StringOutput

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

func (*Cluster) Port 

func (r *Cluster) Port() *pulumi.IntOutput

The port on which the DB accepts connections

func (*Cluster) PreferredBackupWindow 

func (r *Cluster) PreferredBackupWindow() *pulumi.StringOutput

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

func (*Cluster) PreferredMaintenanceWindow 

func (r *Cluster) PreferredMaintenanceWindow() *pulumi.StringOutput

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

func (*Cluster) ReaderEndpoint 

func (r *Cluster) ReaderEndpoint() *pulumi.StringOutput

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

func (*Cluster) ReplicationSourceIdentifier 

func (r *Cluster) ReplicationSourceIdentifier() *pulumi.StringOutput

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

func (*Cluster) S3Import 

func (r *Cluster) S3Import() *pulumi.Output

func (*Cluster) ScalingConfiguration added in v0.16.0 

func (r *Cluster) ScalingConfiguration() *pulumi.Output

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

func (*Cluster) SkipFinalSnapshot 

func (r *Cluster) SkipFinalSnapshot() *pulumi.BoolOutput

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

func (*Cluster) SnapshotIdentifier 

func (r *Cluster) SnapshotIdentifier() *pulumi.StringOutput

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.

func (*Cluster) SourceRegion 

func (r *Cluster) SourceRegion() *pulumi.StringOutput

The source region for an encrypted replica DB cluster.

func (*Cluster) StorageEncrypted 

func (r *Cluster) StorageEncrypted() *pulumi.BoolOutput

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

func (*Cluster) Tags 

func (r *Cluster) Tags() *pulumi.MapOutput

A mapping of tags to assign to the DB cluster.

func (*Cluster) URN 

func (r *Cluster) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

func (*Cluster) VpcSecurityGroupIds 

func (r *Cluster) VpcSecurityGroupIds() *pulumi.ArrayOutput

List of VPC security groups to associate with the Cluster

type ClusterArgs 

type ClusterArgs struct {
	// Specifies whether any cluster modifications
	// are applied immediately, or during the next maintenance window. Default is
	// `false`. See [Amazon RDS Documentation for more information.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html)
	ApplyImmediately interface{}
	// A list of EC2 Availability Zones that
	// instances in the DB cluster can be created in
	AvailabilityZones interface{}
	// 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)
	BacktrackWindow interface{}
	// The days to retain backups for. Default `1`
	BackupRetentionPeriod interface{}
	// The cluster identifier. If omitted, Terraform will assign a random, unique identifier.
	ClusterIdentifier interface{}
	// Creates a unique cluster identifier beginning with the specified prefix. Conflicts with `cluster_identifier`.
	ClusterIdentifierPrefix interface{}
	// List of RDS Instances that are a part of this cluster
	ClusterMembers interface{}
	// Name for an automatically created database on cluster creation. There are different naming restrictions per database engine: [RDS Naming Constraints][5]
	DatabaseName interface{}
	// A cluster parameter group to associate with the cluster.
	DbClusterParameterGroupName interface{}
	// 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.
	DbSubnetGroupName interface{}
	// 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`.
	DeletionProtection interface{}
	// 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`.
	EnabledCloudwatchLogsExports interface{}
	// The name of the database engine to be used for this DB cluster. Defaults to `aurora`. Valid Values: `aurora`, `aurora-mysql`, `aurora-postgresql`
	Engine interface{}
	// The database engine mode. Valid values: `global`, `parallelquery`, `provisioned`, `serverless`. Defaults to: `provisioned`. See the [RDS User Guide](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/aurora-serverless.html) for limitations when using `serverless`.
	EngineMode interface{}
	// The database engine version. Updating this argument results in an outage.
	EngineVersion interface{}
	// The name of your final DB snapshot
	// when this DB cluster is deleted. If omitted, no final snapshot will be
	// made.
	FinalSnapshotIdentifier interface{}
	// The global cluster identifier specified on [`aws_rds_global_cluster`](https://www.terraform.io/docs/providers/aws/r/rds_global_cluster.html).
	GlobalClusterIdentifier interface{}
	// Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Please see [AWS Documentation](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) for availability and limitations.
	IamDatabaseAuthenticationEnabled interface{}
	// A List of ARNs for the IAM roles to associate to the RDS Cluster.
	IamRoles interface{}
	// The ARN for the KMS encryption key. When specifying `kms_key_id`, `storage_encrypted` needs to be set to true.
	KmsKeyId interface{}
	// 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]
	MasterPassword interface{}
	// Username for the master DB user. Please refer to the [RDS Naming Constraints][5]
	MasterUsername interface{}
	// The port on which the DB accepts connections
	Port interface{}
	// 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
	PreferredBackupWindow interface{}
	// The weekly time range during which system maintenance can occur, in (UTC) e.g. wed:04:00-wed:04:30
	PreferredMaintenanceWindow interface{}
	// ARN of a source DB cluster or DB instance if this DB cluster is to be created as a Read Replica.
	ReplicationSourceIdentifier interface{}
	S3Import                    interface{}
	// Nested attribute with scaling properties. Only valid when `engine_mode` is set to `serverless`. More details below.
	ScalingConfiguration interface{}
	// 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`.
	SkipFinalSnapshot interface{}
	// 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.
	SnapshotIdentifier interface{}
	// The source region for an encrypted replica DB cluster.
	SourceRegion interface{}
	// Specifies whether the DB cluster is encrypted. The default is `false` for `provisioned` `engine_mode` and `true` for `serverless` `engine_mode`.
	StorageEncrypted interface{}
	// A mapping of tags to assign to the DB cluster.
	Tags interface{}
	// List of VPC security groups to associate
	// with the Cluster
	VpcSecurityGroupIds interface{}
}

The set of arguments for constructing a Cluster resource.

type ClusterEndpoint added in v0.16.4 

type ClusterEndpoint struct {
	// contains filtered or unexported fields
}

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

func GetClusterEndpoint added in v0.16.4 

func GetClusterEndpoint(ctx *pulumi.Context,
	name string, id pulumi.ID, state *ClusterEndpointState, opts ...pulumi.ResourceOpt) (*ClusterEndpoint, error)

GetClusterEndpoint gets an existing ClusterEndpoint resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewClusterEndpoint added in v0.16.4 

func NewClusterEndpoint(ctx *pulumi.Context,
	name string, args *ClusterEndpointArgs, opts ...pulumi.ResourceOpt) (*ClusterEndpoint, error)

NewClusterEndpoint registers a new resource with the given unique name, arguments, and options.

func (*ClusterEndpoint) Arn added in v0.16.4 

func (r *ClusterEndpoint) Arn() *pulumi.StringOutput

Amazon Resource Name (ARN) of cluster

func (*ClusterEndpoint) ClusterEndpointIdentifier added in v0.16.4 

func (r *ClusterEndpoint) ClusterEndpointIdentifier() *pulumi.StringOutput

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

func (*ClusterEndpoint) ClusterIdentifier added in v0.16.4 

func (r *ClusterEndpoint) ClusterIdentifier() *pulumi.StringOutput

The cluster identifier.

func (*ClusterEndpoint) CustomEndpointType added in v0.16.4 

func (r *ClusterEndpoint) CustomEndpointType() *pulumi.StringOutput

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

func (*ClusterEndpoint) Endpoint added in v0.16.4 

func (r *ClusterEndpoint) Endpoint() *pulumi.StringOutput

A custom endpoint for the Aurora cluster

func (*ClusterEndpoint) ExcludedMembers added in v0.16.4 

func (r *ClusterEndpoint) ExcludedMembers() *pulumi.ArrayOutput

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

func (*ClusterEndpoint) ID added in v0.16.4 

func (r *ClusterEndpoint) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*ClusterEndpoint) StaticMembers added in v0.16.4 

func (r *ClusterEndpoint) StaticMembers() *pulumi.ArrayOutput

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

func (*ClusterEndpoint) URN added in v0.16.4 

func (r *ClusterEndpoint) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type ClusterEndpointArgs added in v0.16.4 

type ClusterEndpointArgs struct {
	// The identifier to use for the new endpoint. This parameter is stored as a lowercase string.
	ClusterEndpointIdentifier interface{}
	// The cluster identifier.
	ClusterIdentifier interface{}
	// The type of the endpoint. One of: READER , ANY .
	CustomEndpointType interface{}
	// 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`.
	ExcludedMembers interface{}
	// List of DB instance identifiers that are part of the custom endpoint group. Conflicts with `excluded_members`.
	StaticMembers interface{}
}

The set of arguments for constructing a ClusterEndpoint resource.

type ClusterEndpointState added in v0.16.4 

type ClusterEndpointState struct {
	// Amazon Resource Name (ARN) of cluster
	Arn interface{}
	// The identifier to use for the new endpoint. This parameter is stored as a lowercase string.
	ClusterEndpointIdentifier interface{}
	// The cluster identifier.
	ClusterIdentifier interface{}
	// The type of the endpoint. One of: READER , ANY .
	CustomEndpointType interface{}
	// A custom endpoint for the Aurora cluster
	Endpoint interface{}
	// 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`.
	ExcludedMembers interface{}
	// List of DB instance identifiers that are part of the custom endpoint group. Conflicts with `excluded_members`.
	StaticMembers interface{}
}

Input properties used for looking up and filtering ClusterEndpoint resources.

type ClusterInstance 

type ClusterInstance struct {
	// contains filtered or unexported fields
}

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.

func GetClusterInstance 

func GetClusterInstance(ctx *pulumi.Context,
	name string, id pulumi.ID, state *ClusterInstanceState, opts ...pulumi.ResourceOpt) (*ClusterInstance, error)

GetClusterInstance gets an existing ClusterInstance resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewClusterInstance 

func NewClusterInstance(ctx *pulumi.Context,
	name string, args *ClusterInstanceArgs, opts ...pulumi.ResourceOpt) (*ClusterInstance, error)

NewClusterInstance registers a new resource with the given unique name, arguments, and options.

func (*ClusterInstance) ApplyImmediately 

func (r *ClusterInstance) ApplyImmediately() *pulumi.BoolOutput

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

func (*ClusterInstance) Arn added in v0.15.1 

func (r *ClusterInstance) Arn() *pulumi.StringOutput

Amazon Resource Name (ARN) of cluster instance

func (*ClusterInstance) AutoMinorVersionUpgrade 

func (r *ClusterInstance) AutoMinorVersionUpgrade() *pulumi.BoolOutput

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

func (*ClusterInstance) AvailabilityZone 

func (r *ClusterInstance) AvailabilityZone() *pulumi.StringOutput

The EC2 Availability Zone that the DB instance is created in. See [docs](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) about the details.

func (*ClusterInstance) ClusterIdentifier 

func (r *ClusterInstance) ClusterIdentifier() *pulumi.StringOutput

The identifier of the [`aws_rds_cluster`](https://www.terraform.io/docs/providers/aws/r/rds_cluster.html) in which to launch this instance.

func (*ClusterInstance) CopyTagsToSnapshot added in v0.16.4 

func (r *ClusterInstance) CopyTagsToSnapshot() *pulumi.BoolOutput

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

func (*ClusterInstance) DbParameterGroupName 

func (r *ClusterInstance) DbParameterGroupName() *pulumi.StringOutput

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

func (*ClusterInstance) DbSubnetGroupName 

func (r *ClusterInstance) DbSubnetGroupName() *pulumi.StringOutput

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

func (*ClusterInstance) DbiResourceId 

func (r *ClusterInstance) DbiResourceId() *pulumi.StringOutput

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

func (*ClusterInstance) Endpoint 

func (r *ClusterInstance) Endpoint() *pulumi.StringOutput

The DNS address for this instance. May not be writable

func (*ClusterInstance) Engine 

func (r *ClusterInstance) Engine() *pulumi.StringOutput

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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AuroraMySQL.Updates.20180206.html) in the Amazon RDS User Guide.

func (*ClusterInstance) EngineVersion 

func (r *ClusterInstance) EngineVersion() *pulumi.StringOutput

The database engine version.

func (*ClusterInstance) ID 

func (r *ClusterInstance) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*ClusterInstance) Identifier 

func (r *ClusterInstance) Identifier() *pulumi.StringOutput

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

func (*ClusterInstance) IdentifierPrefix 

func (r *ClusterInstance) IdentifierPrefix() *pulumi.StringOutput

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

func (*ClusterInstance) InstanceClass 

func (r *ClusterInstance) InstanceClass() *pulumi.StringOutput

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

func (*ClusterInstance) KmsKeyId 

func (r *ClusterInstance) KmsKeyId() *pulumi.StringOutput

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

func (*ClusterInstance) MonitoringInterval 

func (r *ClusterInstance) MonitoringInterval() *pulumi.IntOutput

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.

func (*ClusterInstance) MonitoringRoleArn 

func (r *ClusterInstance) MonitoringRoleArn() *pulumi.StringOutput

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](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html) what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.

func (*ClusterInstance) PerformanceInsightsEnabled 

func (r *ClusterInstance) PerformanceInsightsEnabled() *pulumi.BoolOutput

Specifies whether Performance Insights is enabled or not.

func (*ClusterInstance) PerformanceInsightsKmsKeyId 

func (r *ClusterInstance) PerformanceInsightsKmsKeyId() *pulumi.StringOutput

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.

func (*ClusterInstance) Port 

func (r *ClusterInstance) Port() *pulumi.IntOutput

The database port

func (*ClusterInstance) PreferredBackupWindow 

func (r *ClusterInstance) PreferredBackupWindow() *pulumi.StringOutput

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

func (*ClusterInstance) PreferredMaintenanceWindow 

func (r *ClusterInstance) PreferredMaintenanceWindow() *pulumi.StringOutput

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

func (*ClusterInstance) PromotionTier 

func (r *ClusterInstance) PromotionTier() *pulumi.IntOutput

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

func (*ClusterInstance) PubliclyAccessible 

func (r *ClusterInstance) PubliclyAccessible() *pulumi.BoolOutput

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.

func (*ClusterInstance) StorageEncrypted 

func (r *ClusterInstance) StorageEncrypted() *pulumi.BoolOutput

Specifies whether the DB cluster is encrypted.

func (*ClusterInstance) Tags 

func (r *ClusterInstance) Tags() *pulumi.MapOutput

A mapping of tags to assign to the instance.

func (*ClusterInstance) URN 

func (r *ClusterInstance) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

func (*ClusterInstance) Writer 

func (r *ClusterInstance) Writer() *pulumi.BoolOutput

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

type ClusterInstanceArgs 

type ClusterInstanceArgs struct {
	// Specifies whether any database modifications
	// are applied immediately, or during the next maintenance window. Default is`false`.
	ApplyImmediately interface{}
	// Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default `true`.
	AutoMinorVersionUpgrade interface{}
	// The EC2 Availability Zone that the DB instance is created in. See [docs](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) about the details.
	AvailabilityZone interface{}
	// The identifier of the [`aws_rds_cluster`](https://www.terraform.io/docs/providers/aws/r/rds_cluster.html) in which to launch this instance.
	ClusterIdentifier interface{}
	// Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance. Default `false`.
	CopyTagsToSnapshot interface{}
	// The name of the DB parameter group to associate with this instance.
	DbParameterGroupName interface{}
	// 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).
	DbSubnetGroupName interface{}
	// 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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AuroraMySQL.Updates.20180206.html)
	// in the Amazon RDS User Guide.
	Engine interface{}
	// The database engine version.
	EngineVersion interface{}
	// The indentifier for the RDS instance, if omitted, Terraform will assign a random, unique identifier.
	Identifier interface{}
	// Creates a unique identifier beginning with the specified prefix. Conflicts with `identifier`.
	IdentifierPrefix interface{}
	// 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
	InstanceClass interface{}
	// 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.
	MonitoringInterval interface{}
	// 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](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html)
	// what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
	MonitoringRoleArn interface{}
	// Specifies whether Performance Insights is enabled or not.
	PerformanceInsightsEnabled interface{}
	// 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.
	PerformanceInsightsKmsKeyId interface{}
	// The daily time range during which automated backups are created if automated backups are enabled.
	// Eg: "04:00-09:00"
	PreferredBackupWindow interface{}
	// The window to perform maintenance in.
	// Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
	PreferredMaintenanceWindow interface{}
	// Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoter to writer.
	PromotionTier interface{}
	// 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.
	PubliclyAccessible interface{}
	// A mapping of tags to assign to the instance.
	Tags interface{}
}

The set of arguments for constructing a ClusterInstance resource.

type ClusterInstanceState 

type ClusterInstanceState struct {
	// Specifies whether any database modifications
	// are applied immediately, or during the next maintenance window. Default is`false`.
	ApplyImmediately interface{}
	// Amazon Resource Name (ARN) of cluster instance
	Arn interface{}
	// Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default `true`.
	AutoMinorVersionUpgrade interface{}
	// The EC2 Availability Zone that the DB instance is created in. See [docs](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) about the details.
	AvailabilityZone interface{}
	// The identifier of the [`aws_rds_cluster`](https://www.terraform.io/docs/providers/aws/r/rds_cluster.html) in which to launch this instance.
	ClusterIdentifier interface{}
	// Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance. Default `false`.
	CopyTagsToSnapshot interface{}
	// The name of the DB parameter group to associate with this instance.
	DbParameterGroupName interface{}
	// 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).
	DbSubnetGroupName interface{}
	// The region-unique, immutable identifier for the DB instance.
	DbiResourceId interface{}
	// The DNS address for this instance. May not be writable
	Endpoint interface{}
	// 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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AuroraMySQL.Updates.20180206.html)
	// in the Amazon RDS User Guide.
	Engine interface{}
	// The database engine version.
	EngineVersion interface{}
	// The indentifier for the RDS instance, if omitted, Terraform will assign a random, unique identifier.
	Identifier interface{}
	// Creates a unique identifier beginning with the specified prefix. Conflicts with `identifier`.
	IdentifierPrefix interface{}
	// 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
	InstanceClass interface{}
	// The ARN for the KMS encryption key if one is set to the cluster.
	KmsKeyId interface{}
	// 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.
	MonitoringInterval interface{}
	// 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](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html)
	// what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
	MonitoringRoleArn interface{}
	// Specifies whether Performance Insights is enabled or not.
	PerformanceInsightsEnabled interface{}
	// 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.
	PerformanceInsightsKmsKeyId interface{}
	// The database port
	Port interface{}
	// The daily time range during which automated backups are created if automated backups are enabled.
	// Eg: "04:00-09:00"
	PreferredBackupWindow interface{}
	// The window to perform maintenance in.
	// Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
	PreferredMaintenanceWindow interface{}
	// Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoter to writer.
	PromotionTier interface{}
	// 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.
	PubliclyAccessible interface{}
	// Specifies whether the DB cluster is encrypted.
	StorageEncrypted interface{}
	// A mapping of tags to assign to the instance.
	Tags interface{}
	// Boolean indicating if this instance is writable. `False` indicates this instance is a read replica.
	Writer interface{}
}

Input properties used for looking up and filtering ClusterInstance resources.

type ClusterParameterGroup 

type ClusterParameterGroup struct {
	// contains filtered or unexported fields
}

Provides an RDS DB cluster parameter group resource. Documentation of the available parameters for various Aurora engines can be found at: * [Aurora MySQL Parameters](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AuroraMySQL.Reference.html) * [Aurora PostgreSQL Parameters](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AuroraPostgreSQL.Reference.html)

func GetClusterParameterGroup 

func GetClusterParameterGroup(ctx *pulumi.Context,
	name string, id pulumi.ID, state *ClusterParameterGroupState, opts ...pulumi.ResourceOpt) (*ClusterParameterGroup, error)

GetClusterParameterGroup gets an existing ClusterParameterGroup resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewClusterParameterGroup 

func NewClusterParameterGroup(ctx *pulumi.Context,
	name string, args *ClusterParameterGroupArgs, opts ...pulumi.ResourceOpt) (*ClusterParameterGroup, error)

NewClusterParameterGroup registers a new resource with the given unique name, arguments, and options.

func (*ClusterParameterGroup) Arn 

func (r *ClusterParameterGroup) Arn() *pulumi.StringOutput

The ARN of the db cluster parameter group.

func (*ClusterParameterGroup) Description 

func (r *ClusterParameterGroup) Description() *pulumi.StringOutput

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

func (*ClusterParameterGroup) Family 

func (r *ClusterParameterGroup) Family() *pulumi.StringOutput

The family of the DB cluster parameter group.

func (*ClusterParameterGroup) ID 

func (r *ClusterParameterGroup) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*ClusterParameterGroup) Name 

func (r *ClusterParameterGroup) Name() *pulumi.StringOutput

The name of the DB parameter.

func (*ClusterParameterGroup) NamePrefix 

func (r *ClusterParameterGroup) NamePrefix() *pulumi.StringOutput

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

func (*ClusterParameterGroup) Parameters 

func (r *ClusterParameterGroup) Parameters() *pulumi.ArrayOutput

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.

func (*ClusterParameterGroup) Tags 

func (r *ClusterParameterGroup) Tags() *pulumi.MapOutput

A mapping of tags to assign to the resource.

func (*ClusterParameterGroup) URN 

func (r *ClusterParameterGroup) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type ClusterParameterGroupArgs 

type ClusterParameterGroupArgs struct {
	// The description of the DB cluster parameter group. Defaults to "Managed by Terraform".
	Description interface{}
	// The family of the DB cluster parameter group.
	Family interface{}
	// The name of the DB parameter.
	Name interface{}
	// Creates a unique name beginning with the specified prefix. Conflicts with `name`.
	NamePrefix interface{}
	// 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.
	Parameters interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
}

The set of arguments for constructing a ClusterParameterGroup resource.

type ClusterParameterGroupState 

type ClusterParameterGroupState struct {
	// The ARN of the db cluster parameter group.
	Arn interface{}
	// The description of the DB cluster parameter group. Defaults to "Managed by Terraform".
	Description interface{}
	// The family of the DB cluster parameter group.
	Family interface{}
	// The name of the DB parameter.
	Name interface{}
	// Creates a unique name beginning with the specified prefix. Conflicts with `name`.
	NamePrefix interface{}
	// 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.
	Parameters interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
}

Input properties used for looking up and filtering ClusterParameterGroup resources.

type ClusterSnapshot added in v0.15.1 

type ClusterSnapshot struct {
	// contains filtered or unexported fields
}

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

func GetClusterSnapshot added in v0.15.1 

func GetClusterSnapshot(ctx *pulumi.Context,
	name string, id pulumi.ID, state *ClusterSnapshotState, opts ...pulumi.ResourceOpt) (*ClusterSnapshot, error)

GetClusterSnapshot gets an existing ClusterSnapshot resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewClusterSnapshot added in v0.15.1 

func NewClusterSnapshot(ctx *pulumi.Context,
	name string, args *ClusterSnapshotArgs, opts ...pulumi.ResourceOpt) (*ClusterSnapshot, error)

NewClusterSnapshot registers a new resource with the given unique name, arguments, and options.

func (*ClusterSnapshot) AllocatedStorage added in v0.15.1 

func (r *ClusterSnapshot) AllocatedStorage() *pulumi.IntOutput

Specifies the allocated storage size in gigabytes (GB).

func (*ClusterSnapshot) AvailabilityZones added in v0.15.1 

func (r *ClusterSnapshot) AvailabilityZones() *pulumi.ArrayOutput

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

func (*ClusterSnapshot) DbClusterIdentifier added in v0.15.1 

func (r *ClusterSnapshot) DbClusterIdentifier() *pulumi.StringOutput

The DB Cluster Identifier from which to take the snapshot.

func (*ClusterSnapshot) DbClusterSnapshotArn added in v0.15.1 

func (r *ClusterSnapshot) DbClusterSnapshotArn() *pulumi.StringOutput

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

func (*ClusterSnapshot) DbClusterSnapshotIdentifier added in v0.15.1 

func (r *ClusterSnapshot) DbClusterSnapshotIdentifier() *pulumi.StringOutput

The Identifier for the snapshot.

func (*ClusterSnapshot) Engine added in v0.15.1 

func (r *ClusterSnapshot) Engine() *pulumi.StringOutput

Specifies the name of the database engine.

func (*ClusterSnapshot) EngineVersion added in v0.15.1 

func (r *ClusterSnapshot) EngineVersion() *pulumi.StringOutput

Version of the database engine for this DB cluster snapshot.

func (*ClusterSnapshot) ID added in v0.15.1 

func (r *ClusterSnapshot) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*ClusterSnapshot) KmsKeyId added in v0.15.1 

func (r *ClusterSnapshot) KmsKeyId() *pulumi.StringOutput

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

func (*ClusterSnapshot) LicenseModel added in v0.15.1 

func (r *ClusterSnapshot) LicenseModel() *pulumi.StringOutput

License model information for the restored DB cluster.

func (*ClusterSnapshot) Port added in v0.15.1 

func (r *ClusterSnapshot) Port() *pulumi.IntOutput

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

func (*ClusterSnapshot) SnapshotType added in v0.15.1 

func (r *ClusterSnapshot) SnapshotType() *pulumi.StringOutput

func (*ClusterSnapshot) SourceDbClusterSnapshotArn added in v0.15.1 

func (r *ClusterSnapshot) SourceDbClusterSnapshotArn() *pulumi.StringOutput

func (*ClusterSnapshot) Status added in v0.15.1 

func (r *ClusterSnapshot) Status() *pulumi.StringOutput

The status of this DB Cluster Snapshot.

func (*ClusterSnapshot) StorageEncrypted added in v0.15.1 

func (r *ClusterSnapshot) StorageEncrypted() *pulumi.BoolOutput

Specifies whether the DB cluster snapshot is encrypted.

func (*ClusterSnapshot) URN added in v0.15.1 

func (r *ClusterSnapshot) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

func (*ClusterSnapshot) VpcId added in v0.15.1 

func (r *ClusterSnapshot) VpcId() *pulumi.StringOutput

The VPC ID associated with the DB cluster snapshot.

type ClusterSnapshotArgs added in v0.15.1 

type ClusterSnapshotArgs struct {
	// The DB Cluster Identifier from which to take the snapshot.
	DbClusterIdentifier interface{}
	// The Identifier for the snapshot.
	DbClusterSnapshotIdentifier interface{}
}

The set of arguments for constructing a ClusterSnapshot resource.

type ClusterSnapshotState added in v0.15.1 

type ClusterSnapshotState struct {
	// Specifies the allocated storage size in gigabytes (GB).
	AllocatedStorage interface{}
	// List of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
	AvailabilityZones interface{}
	// The DB Cluster Identifier from which to take the snapshot.
	DbClusterIdentifier interface{}
	// The Amazon Resource Name (ARN) for the DB Cluster Snapshot.
	DbClusterSnapshotArn interface{}
	// The Identifier for the snapshot.
	DbClusterSnapshotIdentifier interface{}
	// Specifies the name of the database engine.
	Engine interface{}
	// Version of the database engine for this DB cluster snapshot.
	EngineVersion interface{}
	// If storage_encrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
	KmsKeyId interface{}
	// License model information for the restored DB cluster.
	LicenseModel interface{}
	// Port that the DB cluster was listening on at the time of the snapshot.
	Port                       interface{}
	SnapshotType               interface{}
	SourceDbClusterSnapshotArn interface{}
	// The status of this DB Cluster Snapshot.
	Status interface{}
	// Specifies whether the DB cluster snapshot is encrypted.
	StorageEncrypted interface{}
	// The VPC ID associated with the DB cluster snapshot.
	VpcId interface{}
}

Input properties used for looking up and filtering ClusterSnapshot resources.

type ClusterState 

type ClusterState struct {
	// Specifies whether any cluster modifications
	// are applied immediately, or during the next maintenance window. Default is
	// `false`. See [Amazon RDS Documentation for more information.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html)
	ApplyImmediately interface{}
	// Amazon Resource Name (ARN) of cluster
	Arn interface{}
	// A list of EC2 Availability Zones that
	// instances in the DB cluster can be created in
	AvailabilityZones interface{}
	// 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)
	BacktrackWindow interface{}
	// The days to retain backups for. Default `1`
	BackupRetentionPeriod interface{}
	// The cluster identifier. If omitted, Terraform will assign a random, unique identifier.
	ClusterIdentifier interface{}
	// Creates a unique cluster identifier beginning with the specified prefix. Conflicts with `cluster_identifier`.
	ClusterIdentifierPrefix interface{}
	// List of RDS Instances that are a part of this cluster
	ClusterMembers interface{}
	// The RDS Cluster Resource ID
	ClusterResourceId interface{}
	// Name for an automatically created database on cluster creation. There are different naming restrictions per database engine: [RDS Naming Constraints][5]
	DatabaseName interface{}
	// A cluster parameter group to associate with the cluster.
	DbClusterParameterGroupName interface{}
	// 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.
	DbSubnetGroupName interface{}
	// 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`.
	DeletionProtection interface{}
	// 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`.
	EnabledCloudwatchLogsExports interface{}
	// The DNS address of the RDS instance
	Endpoint interface{}
	// The name of the database engine to be used for this DB cluster. Defaults to `aurora`. Valid Values: `aurora`, `aurora-mysql`, `aurora-postgresql`
	Engine interface{}
	// The database engine mode. Valid values: `global`, `parallelquery`, `provisioned`, `serverless`. Defaults to: `provisioned`. See the [RDS User Guide](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/aurora-serverless.html) for limitations when using `serverless`.
	EngineMode interface{}
	// The database engine version. Updating this argument results in an outage.
	EngineVersion interface{}
	// The name of your final DB snapshot
	// when this DB cluster is deleted. If omitted, no final snapshot will be
	// made.
	FinalSnapshotIdentifier interface{}
	// The global cluster identifier specified on [`aws_rds_global_cluster`](https://www.terraform.io/docs/providers/aws/r/rds_global_cluster.html).
	GlobalClusterIdentifier interface{}
	// The Route53 Hosted Zone ID of the endpoint
	HostedZoneId interface{}
	// Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Please see [AWS Documentation](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) for availability and limitations.
	IamDatabaseAuthenticationEnabled interface{}
	// A List of ARNs for the IAM roles to associate to the RDS Cluster.
	IamRoles interface{}
	// The ARN for the KMS encryption key. When specifying `kms_key_id`, `storage_encrypted` needs to be set to true.
	KmsKeyId interface{}
	// 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]
	MasterPassword interface{}
	// Username for the master DB user. Please refer to the [RDS Naming Constraints][5]
	MasterUsername interface{}
	// The port on which the DB accepts connections
	Port interface{}
	// 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
	PreferredBackupWindow interface{}
	// The weekly time range during which system maintenance can occur, in (UTC) e.g. wed:04:00-wed:04:30
	PreferredMaintenanceWindow interface{}
	// A read-only endpoint for the Aurora cluster, automatically
	// load-balanced across replicas
	ReaderEndpoint interface{}
	// ARN of a source DB cluster or DB instance if this DB cluster is to be created as a Read Replica.
	ReplicationSourceIdentifier interface{}
	S3Import                    interface{}
	// Nested attribute with scaling properties. Only valid when `engine_mode` is set to `serverless`. More details below.
	ScalingConfiguration interface{}
	// 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`.
	SkipFinalSnapshot interface{}
	// 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.
	SnapshotIdentifier interface{}
	// The source region for an encrypted replica DB cluster.
	SourceRegion interface{}
	// Specifies whether the DB cluster is encrypted. The default is `false` for `provisioned` `engine_mode` and `true` for `serverless` `engine_mode`.
	StorageEncrypted interface{}
	// A mapping of tags to assign to the DB cluster.
	Tags interface{}
	// List of VPC security groups to associate
	// with the Cluster
	VpcSecurityGroupIds interface{}
}

Input properties used for looking up and filtering Cluster resources.

type EventSubscription 

type EventSubscription struct {
	// contains filtered or unexported fields
}

Provides a DB event subscription resource.

## 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 * `customer_aws_id` - The AWS customer account associated with the RDS event notification subscription

func GetEventSubscription 

func GetEventSubscription(ctx *pulumi.Context,
	name string, id pulumi.ID, state *EventSubscriptionState, opts ...pulumi.ResourceOpt) (*EventSubscription, error)

GetEventSubscription gets an existing EventSubscription resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewEventSubscription 

func NewEventSubscription(ctx *pulumi.Context,
	name string, args *EventSubscriptionArgs, opts ...pulumi.ResourceOpt) (*EventSubscription, error)

NewEventSubscription registers a new resource with the given unique name, arguments, and options.

func (*EventSubscription) Arn 

func (r *EventSubscription) Arn() *pulumi.StringOutput

func (*EventSubscription) CustomerAwsId 

func (r *EventSubscription) CustomerAwsId() *pulumi.StringOutput

func (*EventSubscription) Enabled 

func (r *EventSubscription) Enabled() *pulumi.BoolOutput

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

func (*EventSubscription) EventCategories 

func (r *EventSubscription) EventCategories() *pulumi.ArrayOutput

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

func (*EventSubscription) ID 

func (r *EventSubscription) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*EventSubscription) Name 

func (r *EventSubscription) Name() *pulumi.StringOutput

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

func (*EventSubscription) NamePrefix 

func (r *EventSubscription) NamePrefix() *pulumi.StringOutput

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

func (*EventSubscription) SnsTopic 

func (r *EventSubscription) SnsTopic() *pulumi.StringOutput

The SNS topic to send events to.

func (*EventSubscription) SourceIds 

func (r *EventSubscription) SourceIds() *pulumi.ArrayOutput

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.

func (*EventSubscription) SourceType 

func (r *EventSubscription) SourceType() *pulumi.StringOutput

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.

func (*EventSubscription) Tags 

func (r *EventSubscription) Tags() *pulumi.MapOutput

A mapping of tags to assign to the resource.

func (*EventSubscription) URN 

func (r *EventSubscription) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type EventSubscriptionArgs 

type EventSubscriptionArgs struct {
	// A boolean flag to enable/disable the subscription. Defaults to true.
	Enabled interface{}
	// 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`.
	EventCategories interface{}
	// The name of the DB event subscription. By default generated by Terraform.
	Name interface{}
	// The name of the DB event subscription. Conflicts with `name`.
	NamePrefix interface{}
	// The SNS topic to send events to.
	SnsTopic interface{}
	// 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.
	SourceIds interface{}
	// 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.
	SourceType interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
}

The set of arguments for constructing a EventSubscription resource.

type EventSubscriptionState 

type EventSubscriptionState struct {
	Arn           interface{}
	CustomerAwsId interface{}
	// A boolean flag to enable/disable the subscription. Defaults to true.
	Enabled interface{}
	// 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`.
	EventCategories interface{}
	// The name of the DB event subscription. By default generated by Terraform.
	Name interface{}
	// The name of the DB event subscription. Conflicts with `name`.
	NamePrefix interface{}
	// The SNS topic to send events to.
	SnsTopic interface{}
	// 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.
	SourceIds interface{}
	// 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.
	SourceType interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
}

Input properties used for looking up and filtering EventSubscription resources.

type GetClusterArgs 

type GetClusterArgs struct {
	// The cluster identifier of the RDS cluster.
	ClusterIdentifier interface{}
	Tags              interface{}
}

A collection of arguments for invoking getCluster.

type GetClusterResult 

type GetClusterResult struct {
	Arn                              interface{}
	AvailabilityZones                interface{}
	BackupRetentionPeriod            interface{}
	ClusterMembers                   interface{}
	ClusterResourceId                interface{}
	DatabaseName                     interface{}
	DbClusterParameterGroupName      interface{}
	DbSubnetGroupName                interface{}
	EnabledCloudwatchLogsExports     interface{}
	Endpoint                         interface{}
	Engine                           interface{}
	EngineVersion                    interface{}
	FinalSnapshotIdentifier          interface{}
	IamDatabaseAuthenticationEnabled interface{}
	IamRoles                         interface{}
	KmsKeyId                         interface{}
	MasterUsername                   interface{}
	Port                             interface{}
	PreferredBackupWindow            interface{}
	PreferredMaintenanceWindow       interface{}
	ReaderEndpoint                   interface{}
	ReplicationSourceIdentifier      interface{}
	StorageEncrypted                 interface{}
	Tags                             interface{}
	VpcSecurityGroupIds              interface{}
	// id is the provider-assigned unique ID for this managed resource.
	Id interface{}
}

A collection of values returned by getCluster.

func LookupCluster 

func LookupCluster(ctx *pulumi.Context, args *GetClusterArgs) (*GetClusterResult, error)

Provides information about a RDS cluster.

type GetClusterSnapshotArgs added in v0.15.1 

type GetClusterSnapshotArgs struct {
	// Returns the list of snapshots created by the specific db_cluster
	DbClusterIdentifier interface{}
	// Returns information on a specific snapshot_id.
	DbClusterSnapshotIdentifier interface{}
	// 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`.
	IncludePublic interface{}
	// 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`.
	IncludeShared interface{}
	// If more than one result is returned, use the most recent Snapshot.
	MostRecent interface{}
	// 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`.
	SnapshotType interface{}
}

A collection of arguments for invoking getClusterSnapshot.

type GetClusterSnapshotResult added in v0.15.1 

type GetClusterSnapshotResult struct {
	// Specifies the allocated storage size in gigabytes (GB).
	AllocatedStorage interface{}
	// List of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
	AvailabilityZones interface{}
	// The Amazon Resource Name (ARN) for the DB Cluster Snapshot.
	DbClusterSnapshotArn interface{}
	// Specifies the name of the database engine.
	Engine interface{}
	// Version of the database engine for this DB cluster snapshot.
	EngineVersion interface{}
	// If storage_encrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
	KmsKeyId interface{}
	// License model information for the restored DB cluster.
	LicenseModel interface{}
	// Port that the DB cluster was listening on at the time of the snapshot.
	Port interface{}
	// Time when the snapshot was taken, in Universal Coordinated Time (UTC).
	SnapshotCreateTime         interface{}
	SourceDbClusterSnapshotArn interface{}
	// The status of this DB Cluster Snapshot.
	Status interface{}
	// Specifies whether the DB cluster snapshot is encrypted.
	StorageEncrypted interface{}
	// The VPC ID associated with the DB cluster snapshot.
	VpcId interface{}
	// id is the provider-assigned unique ID for this managed resource.
	Id interface{}
}

A collection of values returned by getClusterSnapshot.

func LookupClusterSnapshot added in v0.15.1 

func LookupClusterSnapshot(ctx *pulumi.Context, args *GetClusterSnapshotArgs) (*GetClusterSnapshotResult, error)

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.

type GetEventCategoriesArgs added in v0.16.0 

type GetEventCategoriesArgs struct {
	// 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.
	SourceType interface{}
}

A collection of arguments for invoking getEventCategories.

type GetEventCategoriesResult added in v0.16.0 

type GetEventCategoriesResult struct {
	// A list of the event categories.
	EventCategories interface{}
	// id is the provider-assigned unique ID for this managed resource.
	Id interface{}
}

A collection of values returned by getEventCategories.

func LookupEventCategories added in v0.16.0 

func LookupEventCategories(ctx *pulumi.Context, args *GetEventCategoriesArgs) (*GetEventCategoriesResult, error)

type GetInstanceArgs 

type GetInstanceArgs struct {
	// The name of the RDS instance
	DbInstanceIdentifier interface{}
}

A collection of arguments for invoking getInstance.

type GetInstanceResult 

type GetInstanceResult struct {
	// The hostname of the RDS instance. See also `endpoint` and `port`.
	Address interface{}
	// Specifies the allocated storage size specified in gigabytes.
	AllocatedStorage interface{}
	// Indicates that minor version patches are applied automatically.
	AutoMinorVersionUpgrade interface{}
	// Specifies the name of the Availability Zone the DB instance is located in.
	AvailabilityZone interface{}
	// Specifies the number of days for which automatic DB snapshots are retained.
	BackupRetentionPeriod interface{}
	// Specifies the identifier of the CA certificate for the DB instance.
	CaCertIdentifier interface{}
	// 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.
	DbClusterIdentifier interface{}
	// The Amazon Resource Name (ARN) for the DB instance.
	DbInstanceArn interface{}
	// Contains the name of the compute and memory capacity class of the DB instance.
	DbInstanceClass interface{}
	// Specifies the port that the DB instance listens on.
	DbInstancePort interface{}
	// 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.
	DbName interface{}
	// Provides the list of DB parameter groups applied to this DB instance.
	DbParameterGroups interface{}
	// Provides List of DB security groups associated to this DB instance.
	DbSecurityGroups interface{}
	// Specifies the name of the subnet group associated with the DB instance.
	DbSubnetGroup interface{}
	// List of log types to export to cloudwatch.
	EnabledCloudwatchLogsExports interface{}
	// The connection endpoint in `address:port` format.
	Endpoint interface{}
	// Provides the name of the database engine to be used for this DB instance.
	Engine interface{}
	// Indicates the database engine version.
	EngineVersion interface{}
	// The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record).
	HostedZoneId interface{}
	// Specifies the Provisioned IOPS (I/O operations per second) value.
	Iops interface{}
	// If StorageEncrypted is true, the KMS key identifier for the encrypted DB instance.
	KmsKeyId interface{}
	// License model information for this DB instance.
	LicenseModel interface{}
	// Contains the master username for the DB instance.
	MasterUsername interface{}
	// The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
	MonitoringInterval interface{}
	// The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to CloudWatch Logs.
	MonitoringRoleArn interface{}
	// Specifies if the DB instance is a Multi-AZ deployment.
	MultiAz interface{}
	// Provides the list of option group memberships for this DB instance.
	OptionGroupMemberships interface{}
	// The database port.
	Port interface{}
	// Specifies the daily time range during which automated backups are created.
	PreferredBackupWindow interface{}
	// Specifies the weekly time range during which system maintenance can occur in UTC.
	PreferredMaintenanceWindow interface{}
	// Specifies the accessibility options for the DB instance.
	PubliclyAccessible interface{}
	// The identifier of the source DB that this is a replica of.
	ReplicateSourceDb interface{}
	// Specifies whether the DB instance is encrypted.
	StorageEncrypted interface{}
	// Specifies the storage type associated with DB instance.
	StorageType interface{}
	// The time zone of the DB instance.
	Timezone interface{}
	// Provides a list of VPC security group elements that the DB instance belongs to.
	VpcSecurityGroups interface{}
	// id is the provider-assigned unique ID for this managed resource.
	Id interface{}
}

A collection of values returned by getInstance.

func LookupInstance 

func LookupInstance(ctx *pulumi.Context, args *GetInstanceArgs) (*GetInstanceResult, error)

Use this data source to get information about an RDS instance

type GetSnapshotArgs 

type GetSnapshotArgs struct {
	// Returns the list of snapshots created by the specific db_instance
	DbInstanceIdentifier interface{}
	// Returns information on a specific snapshot_id.
	DbSnapshotIdentifier interface{}
	// 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`.
	IncludePublic interface{}
	// 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`.
	IncludeShared interface{}
	// If more than one result is returned, use the most
	// recent Snapshot.
	MostRecent interface{}
	// 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`.
	SnapshotType interface{}
}

A collection of arguments for invoking getSnapshot.

type GetSnapshotResult 

type GetSnapshotResult struct {
	// Specifies the allocated storage size in gigabytes (GB).
	AllocatedStorage interface{}
	// Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
	AvailabilityZone interface{}
	// The Amazon Resource Name (ARN) for the DB snapshot.
	DbSnapshotArn interface{}
	// Specifies whether the DB snapshot is encrypted.
	Encrypted interface{}
	// Specifies the name of the database engine.
	Engine interface{}
	// Specifies the version of the database engine.
	EngineVersion interface{}
	// Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
	Iops interface{}
	// The ARN for the KMS encryption key.
	KmsKeyId interface{}
	// License model information for the restored DB instance.
	LicenseModel interface{}
	// Provides the option group name for the DB snapshot.
	OptionGroupName interface{}
	Port            interface{}
	// Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
	SnapshotCreateTime interface{}
	// The DB snapshot Arn that the DB snapshot was copied from. It only has value in case of cross customer or cross region copy.
	SourceDbSnapshotIdentifier interface{}
	// The region that the DB snapshot was created in or copied from.
	SourceRegion interface{}
	// Specifies the status of this DB snapshot.
	Status interface{}
	// Specifies the storage type associated with DB snapshot.
	StorageType interface{}
	// Specifies the ID of the VPC associated with the DB snapshot.
	VpcId interface{}
	// id is the provider-assigned unique ID for this managed resource.
	Id interface{}
}

A collection of values returned by getSnapshot.

func LookupSnapshot 

func LookupSnapshot(ctx *pulumi.Context, args *GetSnapshotArgs) (*GetSnapshotResult, error)

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.

type GlobalCluster added in v0.16.5 

type GlobalCluster struct {
	// contains filtered or unexported fields
}

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](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html#aurora-global-database-creating).

> **NOTE:** RDS only supports the `aurora` engine (MySQL 5.6 compatible) for Global Clusters at this time.

func GetGlobalCluster added in v0.16.5 

func GetGlobalCluster(ctx *pulumi.Context,
	name string, id pulumi.ID, state *GlobalClusterState, opts ...pulumi.ResourceOpt) (*GlobalCluster, error)

GetGlobalCluster gets an existing GlobalCluster resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewGlobalCluster added in v0.16.5 

func NewGlobalCluster(ctx *pulumi.Context,
	name string, args *GlobalClusterArgs, opts ...pulumi.ResourceOpt) (*GlobalCluster, error)

NewGlobalCluster registers a new resource with the given unique name, arguments, and options.

func (*GlobalCluster) Arn added in v0.16.5 

func (r *GlobalCluster) Arn() *pulumi.StringOutput

RDS Global Cluster Amazon Resource Name (ARN)

func (*GlobalCluster) DatabaseName added in v0.16.5 

func (r *GlobalCluster) DatabaseName() *pulumi.StringOutput

Name for an automatically created database on cluster creation.

func (*GlobalCluster) DeletionProtection added in v0.16.5 

func (r *GlobalCluster) DeletionProtection() *pulumi.BoolOutput

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

func (*GlobalCluster) Engine added in v0.16.5 

func (r *GlobalCluster) Engine() *pulumi.StringOutput

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

func (*GlobalCluster) EngineVersion added in v0.16.5 

func (r *GlobalCluster) EngineVersion() *pulumi.StringOutput

Engine version of the Aurora global database.

func (*GlobalCluster) GlobalClusterIdentifier added in v0.16.5 

func (r *GlobalCluster) GlobalClusterIdentifier() *pulumi.StringOutput

func (*GlobalCluster) GlobalClusterResourceId added in v0.16.5 

func (r *GlobalCluster) GlobalClusterResourceId() *pulumi.StringOutput

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

func (*GlobalCluster) ID added in v0.16.5 

func (r *GlobalCluster) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*GlobalCluster) StorageEncrypted added in v0.16.5 

func (r *GlobalCluster) StorageEncrypted() *pulumi.BoolOutput

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

func (*GlobalCluster) URN added in v0.16.5 

func (r *GlobalCluster) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type GlobalClusterArgs added in v0.16.5 

type GlobalClusterArgs struct {
	// Name for an automatically created database on cluster creation.
	DatabaseName interface{}
	// 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`.
	DeletionProtection interface{}
	// Name of the database engine to be used for this DB cluster. Valid values: `aurora`. Defaults to `aurora`.
	Engine interface{}
	// Engine version of the Aurora global database.
	EngineVersion           interface{}
	GlobalClusterIdentifier interface{}
	// Specifies whether the DB cluster is encrypted. The default is `false`.
	StorageEncrypted interface{}
}

The set of arguments for constructing a GlobalCluster resource.

type GlobalClusterState added in v0.16.5 

type GlobalClusterState struct {
	// RDS Global Cluster Amazon Resource Name (ARN)
	Arn interface{}
	// Name for an automatically created database on cluster creation.
	DatabaseName interface{}
	// 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`.
	DeletionProtection interface{}
	// Name of the database engine to be used for this DB cluster. Valid values: `aurora`. Defaults to `aurora`.
	Engine interface{}
	// Engine version of the Aurora global database.
	EngineVersion           interface{}
	GlobalClusterIdentifier interface{}
	// 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
	GlobalClusterResourceId interface{}
	// Specifies whether the DB cluster is encrypted. The default is `false`.
	StorageEncrypted interface{}
}

Input properties used for looking up and filtering GlobalCluster resources.

type Instance 

type Instance struct {
	// contains filtered or unexported fields
}

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](https://www.terraform.io/docs/state/sensitive-data.html).

## 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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html)

func GetInstance 

func GetInstance(ctx *pulumi.Context,
	name string, id pulumi.ID, state *InstanceState, opts ...pulumi.ResourceOpt) (*Instance, error)

GetInstance gets an existing Instance resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewInstance 

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

NewInstance registers a new resource with the given unique name, arguments, and options.

func (*Instance) Address 

func (r *Instance) Address() *pulumi.StringOutput

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

func (*Instance) AllocatedStorage 

func (r *Instance) AllocatedStorage() *pulumi.IntOutput

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

func (*Instance) AllowMajorVersionUpgrade 

func (r *Instance) AllowMajorVersionUpgrade() *pulumi.BoolOutput

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.

func (*Instance) ApplyImmediately 

func (r *Instance) ApplyImmediately() *pulumi.BoolOutput

Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is `false`. See [Amazon RDS Documentation for more information.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html)

func (*Instance) Arn 

func (r *Instance) Arn() *pulumi.StringOutput

The ARN of the RDS instance.

func (*Instance) AutoMinorVersionUpgrade 

func (r *Instance) AutoMinorVersionUpgrade() *pulumi.BoolOutput

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

func (*Instance) AvailabilityZone 

func (r *Instance) AvailabilityZone() *pulumi.StringOutput

The AZ for the RDS instance.

func (*Instance) BackupRetentionPeriod 

func (r *Instance) BackupRetentionPeriod() *pulumi.IntOutput

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

func (*Instance) BackupWindow 

func (r *Instance) BackupWindow() *pulumi.StringOutput

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

func (*Instance) CaCertIdentifier 

func (r *Instance) CaCertIdentifier() *pulumi.StringOutput

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

func (*Instance) CharacterSetName 

func (r *Instance) CharacterSetName() *pulumi.StringOutput

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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.OracleCharacterSets.html) for more information.

func (*Instance) CopyTagsToSnapshot 

func (r *Instance) CopyTagsToSnapshot() *pulumi.BoolOutput

Copy all Instance `tags` to snapshots. Default is `false`.

func (*Instance) DbSubnetGroupName 

func (r *Instance) DbSubnetGroupName() *pulumi.StringOutput

Name of [DB subnet group](https://www.terraform.io/docs/providers/aws/r/db_subnet_group.html). 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](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstanceReadReplica.html) for additional read replica contraints.

func (*Instance) DeletionProtection added in v0.16.1 

func (r *Instance) DeletionProtection() *pulumi.BoolOutput

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

func (*Instance) Domain added in v0.16.0 

func (r *Instance) Domain() *pulumi.StringOutput

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

func (*Instance) DomainIamRoleName added in v0.16.0 

func (r *Instance) DomainIamRoleName() *pulumi.StringOutput

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

func (*Instance) EnabledCloudwatchLogsExports 

func (r *Instance) EnabledCloudwatchLogsExports() *pulumi.ArrayOutput

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

func (*Instance) Endpoint 

func (r *Instance) Endpoint() *pulumi.StringOutput

The connection endpoint in `address:port` format.

func (*Instance) Engine 

func (r *Instance) Engine() *pulumi.StringOutput

(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](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html). Note that for Amazon Aurora instances the engine must match the [DB cluster](https://www.terraform.io/docs/providers/aws/r/rds_cluster.html)'s engine'. For information on the difference between the available Aurora MySQL engines see [Comparison between Aurora MySQL 1 and Aurora MySQL 2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AuroraMySQL.Updates.20180206.html) in the Amazon RDS User Guide.

func (*Instance) EngineVersion 

func (r *Instance) EngineVersion() *pulumi.StringOutput

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](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html). Note that for Amazon Aurora instances the engine version must match the [DB cluster](https://www.terraform.io/docs/providers/aws/r/rds_cluster.html)'s engine version'.

func (*Instance) FinalSnapshotIdentifier 

func (r *Instance) FinalSnapshotIdentifier() *pulumi.StringOutput

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

func (*Instance) HostedZoneId 

func (r *Instance) HostedZoneId() *pulumi.StringOutput

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

func (*Instance) ID 

func (r *Instance) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*Instance) IamDatabaseAuthenticationEnabled 

func (r *Instance) IamDatabaseAuthenticationEnabled() *pulumi.BoolOutput

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

func (*Instance) Identifier 

func (r *Instance) Identifier() *pulumi.StringOutput

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

func (*Instance) IdentifierPrefix 

func (r *Instance) IdentifierPrefix() *pulumi.StringOutput

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

func (*Instance) InstanceClass 

func (r *Instance) InstanceClass() *pulumi.StringOutput

The instance type of the RDS instance.

func (*Instance) Iops 

func (r *Instance) Iops() *pulumi.IntOutput

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

func (*Instance) KmsKeyId 

func (r *Instance) KmsKeyId() *pulumi.StringOutput

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

func (*Instance) LicenseModel 

func (r *Instance) LicenseModel() *pulumi.StringOutput

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

func (*Instance) MaintenanceWindow 

func (r *Instance) MaintenanceWindow() *pulumi.StringOutput

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](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow) for more information.

func (*Instance) MonitoringInterval 

func (r *Instance) MonitoringInterval() *pulumi.IntOutput

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.

func (*Instance) MonitoringRoleArn 

func (r *Instance) MonitoringRoleArn() *pulumi.StringOutput

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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html) what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.

func (*Instance) MultiAz 

func (r *Instance) MultiAz() *pulumi.BoolOutput

Specifies if the RDS instance is multi-AZ

func (*Instance) Name 

func (r *Instance) Name() *pulumi.StringOutput

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](http://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) for more details on what applies for those engines.

func (*Instance) OptionGroupName 

func (r *Instance) OptionGroupName() *pulumi.StringOutput

Name of the DB option group to associate.

func (*Instance) ParameterGroupName 

func (r *Instance) ParameterGroupName() *pulumi.StringOutput

Name of the DB parameter group to associate.

func (*Instance) Password 

func (r *Instance) Password() *pulumi.StringOutput

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

func (*Instance) Port 

func (r *Instance) Port() *pulumi.IntOutput

The port on which the DB accepts connections.

func (*Instance) PubliclyAccessible 

func (r *Instance) PubliclyAccessible() *pulumi.BoolOutput

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

func (*Instance) Replicas 

func (r *Instance) Replicas() *pulumi.ArrayOutput

func (*Instance) ReplicateSourceDb 

func (r *Instance) ReplicateSourceDb() *pulumi.StringOutput

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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReadRepl.html) for more information on using Replication.

func (*Instance) ResourceId 

func (r *Instance) ResourceId() *pulumi.StringOutput

The RDS Resource ID of this instance.

func (*Instance) S3Import 

func (r *Instance) S3Import() *pulumi.Output

Restore from a Percona Xtrabackup in S3. See [Importing Data into an Amazon RDS MySQL DB Instance](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/MySQL.Procedural.Importing.html)

func (*Instance) SecurityGroupNames 

func (r *Instance) SecurityGroupNames() *pulumi.ArrayOutput

List of DB Security Groups to associate. Only used for [DB Instances on the _EC2-Classic_ Platform](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html#USER_VPC.FindDefaultVPC).

func (*Instance) SkipFinalSnapshot 

func (r *Instance) SkipFinalSnapshot() *pulumi.BoolOutput

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

func (*Instance) SnapshotIdentifier 

func (r *Instance) SnapshotIdentifier() *pulumi.StringOutput

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.

func (*Instance) Status 

func (r *Instance) Status() *pulumi.StringOutput

The RDS instance status.

func (*Instance) StorageEncrypted 

func (r *Instance) StorageEncrypted() *pulumi.BoolOutput

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.

func (*Instance) StorageType 

func (r *Instance) StorageType() *pulumi.StringOutput

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

func (*Instance) Tags 

func (r *Instance) Tags() *pulumi.MapOutput

A mapping of tags to assign to the resource.

func (*Instance) Timezone 

func (r *Instance) Timezone() *pulumi.StringOutput

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](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone) for more information.

func (*Instance) URN 

func (r *Instance) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

func (*Instance) Username 

func (r *Instance) Username() *pulumi.StringOutput

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

func (*Instance) VpcSecurityGroupIds 

func (r *Instance) VpcSecurityGroupIds() *pulumi.ArrayOutput

List of VPC security groups to associate.

type InstanceArgs 

type InstanceArgs struct {
	// (Required unless a `snapshot_identifier` or
	// `replicate_source_db` is provided) The allocated storage in gibibytes.
	AllocatedStorage interface{}
	// 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.
	AllowMajorVersionUpgrade interface{}
	// Specifies whether any database modifications
	// are applied immediately, or during the next maintenance window. Default is
	// `false`. See [Amazon RDS Documentation for more
	// information.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html)
	ApplyImmediately interface{}
	// Indicates that minor engine upgrades
	// will be applied automatically to the DB instance during the maintenance window.
	// Defaults to true.
	AutoMinorVersionUpgrade interface{}
	// The AZ for the RDS instance.
	AvailabilityZone interface{}
	// 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].
	BackupRetentionPeriod interface{}
	// 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`.
	BackupWindow interface{}
	// 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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.OracleCharacterSets.html)
	// for more information.
	CharacterSetName interface{}
	// Copy all Instance `tags` to snapshots. Default is `false`.
	CopyTagsToSnapshot interface{}
	// Name of [DB subnet group](https://www.terraform.io/docs/providers/aws/r/db_subnet_group.html). 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](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstanceReadReplica.html)
	// for additional read replica contraints.
	DbSubnetGroupName interface{}
	// 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`.
	DeletionProtection interface{}
	// The ID of the Directory Service Active Directory domain to create the instance in.
	Domain interface{}
	// The name of the IAM role to be used when making API calls to the Directory Service.
	DomainIamRoleName interface{}
	// 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).
	EnabledCloudwatchLogsExports interface{}
	// (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](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html).
	// Note that for Amazon Aurora instances the engine must match the [DB cluster](https://www.terraform.io/docs/providers/aws/r/rds_cluster.html)'s engine'.
	// For information on the difference between the available Aurora MySQL engines
	// see [Comparison between Aurora MySQL 1 and Aurora MySQL 2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AuroraMySQL.Updates.20180206.html)
	// in the Amazon RDS User Guide.
	Engine interface{}
	// 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](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html).
	// Note that for Amazon Aurora instances the engine version must match the [DB cluster](https://www.terraform.io/docs/providers/aws/r/rds_cluster.html)'s engine version'.
	EngineVersion interface{}
	// The name of your final DB snapshot
	// when this DB instance is deleted. If omitted, no final snapshot will be made.
	FinalSnapshotIdentifier interface{}
	// Specifies whether or
	// mappings of AWS Identity and Access Management (IAM) accounts to database
	// accounts is enabled.
	IamDatabaseAuthenticationEnabled interface{}
	// The name of the RDS instance,
	// if omitted, Terraform will assign a random, unique identifier.
	Identifier interface{}
	// Creates a unique
	// identifier beginning with the specified prefix. Conflicts with `identifier`.
	IdentifierPrefix interface{}
	// The instance type of the RDS instance.
	InstanceClass interface{}
	// The amount of provisioned IOPS. Setting this implies a
	// storage_type of "io1".
	Iops interface{}
	// The ARN for the KMS encryption key. If creating an
	// encrypted replica, set this to the destination KMS ARN.
	KmsKeyId interface{}
	// (Optional, but required for some DB engines, i.e. Oracle
	// SE1) License model information for this DB instance.
	LicenseModel interface{}
	// 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](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow)
	// for more information.
	MaintenanceWindow interface{}
	// 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.
	MonitoringInterval interface{}
	// 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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html)
	// what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
	MonitoringRoleArn interface{}
	// Specifies if the RDS instance is multi-AZ
	MultiAz interface{}
	// 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](http://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) for more details on what applies for those engines.
	Name interface{}
	// Name of the DB option group to associate.
	OptionGroupName interface{}
	// Name of the DB parameter group to
	// associate.
	ParameterGroupName interface{}
	// (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.
	Password interface{}
	// The port on which the DB accepts connections.
	Port interface{}
	// Bool to control if instance is publicly
	// accessible. Default is `false`.
	PubliclyAccessible interface{}
	// 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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReadRepl.html)
	// for more information on using Replication.
	ReplicateSourceDb interface{}
	// Restore from a Percona Xtrabackup in S3.  See [Importing Data into an Amazon RDS MySQL DB Instance](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/MySQL.Procedural.Importing.html)
	S3Import interface{}
	// List of DB Security Groups to
	// associate. Only used for [DB Instances on the _EC2-Classic_
	// Platform](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html#USER_VPC.FindDefaultVPC).
	SecurityGroupNames interface{}
	// 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`.
	SkipFinalSnapshot interface{}
	// 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.
	SnapshotIdentifier interface{}
	// 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.
	StorageEncrypted interface{}
	// 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".
	StorageType interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
	// 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](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone)
	// for more information.
	Timezone interface{}
	// (Required unless a `snapshot_identifier` or `replicate_source_db`
	// is provided) Username for the master DB user.
	Username interface{}
	// List of VPC security groups to
	// associate.
	VpcSecurityGroupIds interface{}
}

The set of arguments for constructing a Instance resource.

type InstanceState 

type InstanceState struct {
	// The hostname of the RDS instance. See also `endpoint` and `port`.
	Address interface{}
	// (Required unless a `snapshot_identifier` or
	// `replicate_source_db` is provided) The allocated storage in gibibytes.
	AllocatedStorage interface{}
	// 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.
	AllowMajorVersionUpgrade interface{}
	// Specifies whether any database modifications
	// are applied immediately, or during the next maintenance window. Default is
	// `false`. See [Amazon RDS Documentation for more
	// information.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html)
	ApplyImmediately interface{}
	// The ARN of the RDS instance.
	Arn interface{}
	// Indicates that minor engine upgrades
	// will be applied automatically to the DB instance during the maintenance window.
	// Defaults to true.
	AutoMinorVersionUpgrade interface{}
	// The AZ for the RDS instance.
	AvailabilityZone interface{}
	// 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].
	BackupRetentionPeriod interface{}
	// 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`.
	BackupWindow interface{}
	// Specifies the identifier of the CA certificate for the
	// DB instance.
	CaCertIdentifier interface{}
	// 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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.OracleCharacterSets.html)
	// for more information.
	CharacterSetName interface{}
	// Copy all Instance `tags` to snapshots. Default is `false`.
	CopyTagsToSnapshot interface{}
	// Name of [DB subnet group](https://www.terraform.io/docs/providers/aws/r/db_subnet_group.html). 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](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstanceReadReplica.html)
	// for additional read replica contraints.
	DbSubnetGroupName interface{}
	// 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`.
	DeletionProtection interface{}
	// The ID of the Directory Service Active Directory domain to create the instance in.
	Domain interface{}
	// The name of the IAM role to be used when making API calls to the Directory Service.
	DomainIamRoleName interface{}
	// 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).
	EnabledCloudwatchLogsExports interface{}
	// The connection endpoint in `address:port` format.
	Endpoint interface{}
	// (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](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html).
	// Note that for Amazon Aurora instances the engine must match the [DB cluster](https://www.terraform.io/docs/providers/aws/r/rds_cluster.html)'s engine'.
	// For information on the difference between the available Aurora MySQL engines
	// see [Comparison between Aurora MySQL 1 and Aurora MySQL 2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AuroraMySQL.Updates.20180206.html)
	// in the Amazon RDS User Guide.
	Engine interface{}
	// 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](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html).
	// Note that for Amazon Aurora instances the engine version must match the [DB cluster](https://www.terraform.io/docs/providers/aws/r/rds_cluster.html)'s engine version'.
	EngineVersion interface{}
	// The name of your final DB snapshot
	// when this DB instance is deleted. If omitted, no final snapshot will be made.
	FinalSnapshotIdentifier interface{}
	// The canonical hosted zone ID of the DB instance (to be used
	// in a Route 53 Alias record).
	HostedZoneId interface{}
	// Specifies whether or
	// mappings of AWS Identity and Access Management (IAM) accounts to database
	// accounts is enabled.
	IamDatabaseAuthenticationEnabled interface{}
	// The name of the RDS instance,
	// if omitted, Terraform will assign a random, unique identifier.
	Identifier interface{}
	// Creates a unique
	// identifier beginning with the specified prefix. Conflicts with `identifier`.
	IdentifierPrefix interface{}
	// The instance type of the RDS instance.
	InstanceClass interface{}
	// The amount of provisioned IOPS. Setting this implies a
	// storage_type of "io1".
	Iops interface{}
	// The ARN for the KMS encryption key. If creating an
	// encrypted replica, set this to the destination KMS ARN.
	KmsKeyId interface{}
	// (Optional, but required for some DB engines, i.e. Oracle
	// SE1) License model information for this DB instance.
	LicenseModel interface{}
	// 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](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow)
	// for more information.
	MaintenanceWindow interface{}
	// 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.
	MonitoringInterval interface{}
	// 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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html)
	// what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
	MonitoringRoleArn interface{}
	// Specifies if the RDS instance is multi-AZ
	MultiAz interface{}
	// 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](http://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) for more details on what applies for those engines.
	Name interface{}
	// Name of the DB option group to associate.
	OptionGroupName interface{}
	// Name of the DB parameter group to
	// associate.
	ParameterGroupName interface{}
	// (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.
	Password interface{}
	// The port on which the DB accepts connections.
	Port interface{}
	// Bool to control if instance is publicly
	// accessible. Default is `false`.
	PubliclyAccessible interface{}
	Replicas           interface{}
	// 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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReadRepl.html)
	// for more information on using Replication.
	ReplicateSourceDb interface{}
	// The RDS Resource ID of this instance.
	ResourceId interface{}
	// Restore from a Percona Xtrabackup in S3.  See [Importing Data into an Amazon RDS MySQL DB Instance](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/MySQL.Procedural.Importing.html)
	S3Import interface{}
	// List of DB Security Groups to
	// associate. Only used for [DB Instances on the _EC2-Classic_
	// Platform](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html#USER_VPC.FindDefaultVPC).
	SecurityGroupNames interface{}
	// 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`.
	SkipFinalSnapshot interface{}
	// 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.
	SnapshotIdentifier interface{}
	// The RDS instance status.
	Status interface{}
	// 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.
	StorageEncrypted interface{}
	// 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".
	StorageType interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
	// 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](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone)
	// for more information.
	Timezone interface{}
	// (Required unless a `snapshot_identifier` or `replicate_source_db`
	// is provided) Username for the master DB user.
	Username interface{}
	// List of VPC security groups to
	// associate.
	VpcSecurityGroupIds interface{}
}

Input properties used for looking up and filtering Instance resources.

type OptionGroup 

type OptionGroup struct {
	// contains filtered or unexported fields
}

Provides an RDS DB option group resource. Documentation of the available options for various RDS engines can be found at: * [MariaDB Options](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.MariaDB.Options.html) * [Microsoft SQL Server Options](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.SQLServer.Options.html) * [MySQL Options](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.MySQL.Options.html) * [Oracle Options](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.Options.html)

func GetOptionGroup 

func GetOptionGroup(ctx *pulumi.Context,
	name string, id pulumi.ID, state *OptionGroupState, opts ...pulumi.ResourceOpt) (*OptionGroup, error)

GetOptionGroup gets an existing OptionGroup resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewOptionGroup 

func NewOptionGroup(ctx *pulumi.Context,
	name string, args *OptionGroupArgs, opts ...pulumi.ResourceOpt) (*OptionGroup, error)

NewOptionGroup registers a new resource with the given unique name, arguments, and options.

func (*OptionGroup) Arn 

func (r *OptionGroup) Arn() *pulumi.StringOutput

The ARN of the db option group.

func (*OptionGroup) EngineName 

func (r *OptionGroup) EngineName() *pulumi.StringOutput

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

func (*OptionGroup) ID 

func (r *OptionGroup) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*OptionGroup) MajorEngineVersion 

func (r *OptionGroup) MajorEngineVersion() *pulumi.StringOutput

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

func (*OptionGroup) Name 

func (r *OptionGroup) Name() *pulumi.StringOutput

The Name of the setting.

func (*OptionGroup) NamePrefix 

func (r *OptionGroup) NamePrefix() *pulumi.StringOutput

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

func (*OptionGroup) OptionGroupDescription 

func (r *OptionGroup) OptionGroupDescription() *pulumi.StringOutput

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

func (*OptionGroup) Options 

func (r *OptionGroup) Options() *pulumi.ArrayOutput

A list of Options to apply.

func (*OptionGroup) Tags 

func (r *OptionGroup) Tags() *pulumi.MapOutput

A mapping of tags to assign to the resource.

func (*OptionGroup) URN 

func (r *OptionGroup) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type OptionGroupArgs 

type OptionGroupArgs struct {
	// Specifies the name of the engine that this option group should be associated with.
	EngineName interface{}
	// Specifies the major version of the engine that this option group should be associated with.
	MajorEngineVersion interface{}
	// The Name of the setting.
	Name interface{}
	// Creates a unique name beginning with the specified prefix. Conflicts with `name`. Must be lowercase, to match as it is stored in AWS.
	NamePrefix interface{}
	// A list of Options to apply.
	Options interface{}
	// The description of the option group. Defaults to "Managed by Terraform".
	OptionGroupDescription interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
}

The set of arguments for constructing a OptionGroup resource.

type OptionGroupState 

type OptionGroupState struct {
	// The ARN of the db option group.
	Arn interface{}
	// Specifies the name of the engine that this option group should be associated with.
	EngineName interface{}
	// Specifies the major version of the engine that this option group should be associated with.
	MajorEngineVersion interface{}
	// The Name of the setting.
	Name interface{}
	// Creates a unique name beginning with the specified prefix. Conflicts with `name`. Must be lowercase, to match as it is stored in AWS.
	NamePrefix interface{}
	// A list of Options to apply.
	Options interface{}
	// The description of the option group. Defaults to "Managed by Terraform".
	OptionGroupDescription interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
}

Input properties used for looking up and filtering OptionGroup resources.

type ParameterGroup 

type ParameterGroup struct {
	// contains filtered or unexported fields
}

Provides an RDS DB parameter group resource .Documentation of the available parameters for various RDS engines can be found at: * [Aurora MySQL Parameters](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AuroraMySQL.Reference.html) * [Aurora PostgreSQL Parameters](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AuroraPostgreSQL.Reference.html) * [MariaDB Parameters](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.MariaDB.Parameters.html) * [Oracle Parameters](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ModifyInstance.Oracle.html#USER_ModifyInstance.Oracle.sqlnet) * [PostgreSQL Parameters](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.PostgreSQL.CommonDBATasks.html#Appendix.PostgreSQL.CommonDBATasks.Parameters)

func GetParameterGroup 

func GetParameterGroup(ctx *pulumi.Context,
	name string, id pulumi.ID, state *ParameterGroupState, opts ...pulumi.ResourceOpt) (*ParameterGroup, error)

GetParameterGroup gets an existing ParameterGroup resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewParameterGroup 

func NewParameterGroup(ctx *pulumi.Context,
	name string, args *ParameterGroupArgs, opts ...pulumi.ResourceOpt) (*ParameterGroup, error)

NewParameterGroup registers a new resource with the given unique name, arguments, and options.

func (*ParameterGroup) Arn 

func (r *ParameterGroup) Arn() *pulumi.StringOutput

The ARN of the db parameter group.

func (*ParameterGroup) Description 

func (r *ParameterGroup) Description() *pulumi.StringOutput

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

func (*ParameterGroup) Family 

func (r *ParameterGroup) Family() *pulumi.StringOutput

The family of the DB parameter group.

func (*ParameterGroup) ID 

func (r *ParameterGroup) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*ParameterGroup) Name 

func (r *ParameterGroup) Name() *pulumi.StringOutput

The name of the DB parameter.

func (*ParameterGroup) NamePrefix 

func (r *ParameterGroup) NamePrefix() *pulumi.StringOutput

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

func (*ParameterGroup) Parameters 

func (r *ParameterGroup) Parameters() *pulumi.ArrayOutput

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.

func (*ParameterGroup) Tags 

func (r *ParameterGroup) Tags() *pulumi.MapOutput

A mapping of tags to assign to the resource.

func (*ParameterGroup) URN 

func (r *ParameterGroup) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type ParameterGroupArgs 

type ParameterGroupArgs struct {
	// The description of the DB parameter group. Defaults to "Managed by Terraform".
	Description interface{}
	// The family of the DB parameter group.
	Family interface{}
	// The name of the DB parameter.
	Name interface{}
	// Creates a unique name beginning with the specified prefix. Conflicts with `name`.
	NamePrefix interface{}
	// 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.
	Parameters interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
}

The set of arguments for constructing a ParameterGroup resource.

type ParameterGroupState 

type ParameterGroupState struct {
	// The ARN of the db parameter group.
	Arn interface{}
	// The description of the DB parameter group. Defaults to "Managed by Terraform".
	Description interface{}
	// The family of the DB parameter group.
	Family interface{}
	// The name of the DB parameter.
	Name interface{}
	// Creates a unique name beginning with the specified prefix. Conflicts with `name`.
	NamePrefix interface{}
	// 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.
	Parameters interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
}

Input properties used for looking up and filtering ParameterGroup resources.

type SecurityGroup 

type SecurityGroup struct {
	// contains filtered or unexported fields
}

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.

func GetSecurityGroup 

func GetSecurityGroup(ctx *pulumi.Context,
	name string, id pulumi.ID, state *SecurityGroupState, opts ...pulumi.ResourceOpt) (*SecurityGroup, error)

GetSecurityGroup gets an existing SecurityGroup resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewSecurityGroup 

func NewSecurityGroup(ctx *pulumi.Context,
	name string, args *SecurityGroupArgs, opts ...pulumi.ResourceOpt) (*SecurityGroup, error)

NewSecurityGroup registers a new resource with the given unique name, arguments, and options.

func (*SecurityGroup) Arn 

func (r *SecurityGroup) Arn() *pulumi.StringOutput

The arn of the DB security group.

func (*SecurityGroup) Description 

func (r *SecurityGroup) Description() *pulumi.StringOutput

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

func (*SecurityGroup) ID 

func (r *SecurityGroup) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*SecurityGroup) Ingress 

func (r *SecurityGroup) Ingress() *pulumi.ArrayOutput

A list of ingress rules.

func (*SecurityGroup) Name 

func (r *SecurityGroup) Name() *pulumi.StringOutput

The name of the DB security group.

func (*SecurityGroup) Tags 

func (r *SecurityGroup) Tags() *pulumi.MapOutput

A mapping of tags to assign to the resource.

func (*SecurityGroup) URN 

func (r *SecurityGroup) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type SecurityGroupArgs 

type SecurityGroupArgs struct {
	// The description of the DB security group. Defaults to "Managed by Terraform".
	Description interface{}
	// A list of ingress rules.
	Ingress interface{}
	// The name of the DB security group.
	Name interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
}

The set of arguments for constructing a SecurityGroup resource.

type SecurityGroupState 

type SecurityGroupState struct {
	// The arn of the DB security group.
	Arn interface{}
	// The description of the DB security group. Defaults to "Managed by Terraform".
	Description interface{}
	// A list of ingress rules.
	Ingress interface{}
	// The name of the DB security group.
	Name interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
}

Input properties used for looking up and filtering SecurityGroup resources.

type Snapshot 

type Snapshot struct {
	// contains filtered or unexported fields
}

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

func GetSnapshot 

func GetSnapshot(ctx *pulumi.Context,
	name string, id pulumi.ID, state *SnapshotState, opts ...pulumi.ResourceOpt) (*Snapshot, error)

GetSnapshot gets an existing Snapshot resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewSnapshot 

func NewSnapshot(ctx *pulumi.Context,
	name string, args *SnapshotArgs, opts ...pulumi.ResourceOpt) (*Snapshot, error)

NewSnapshot registers a new resource with the given unique name, arguments, and options.

func (*Snapshot) AllocatedStorage 

func (r *Snapshot) AllocatedStorage() *pulumi.IntOutput

Specifies the allocated storage size in gigabytes (GB).

func (*Snapshot) AvailabilityZone 

func (r *Snapshot) AvailabilityZone() *pulumi.StringOutput

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

func (*Snapshot) DbInstanceIdentifier 

func (r *Snapshot) DbInstanceIdentifier() *pulumi.StringOutput

The DB Instance Identifier from which to take the snapshot.

func (*Snapshot) DbSnapshotArn 

func (r *Snapshot) DbSnapshotArn() *pulumi.StringOutput

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

func (*Snapshot) DbSnapshotIdentifier 

func (r *Snapshot) DbSnapshotIdentifier() *pulumi.StringOutput

The Identifier for the snapshot.

func (*Snapshot) Encrypted 

func (r *Snapshot) Encrypted() *pulumi.BoolOutput

Specifies whether the DB snapshot is encrypted.

func (*Snapshot) Engine 

func (r *Snapshot) Engine() *pulumi.StringOutput

Specifies the name of the database engine.

func (*Snapshot) EngineVersion 

func (r *Snapshot) EngineVersion() *pulumi.StringOutput

Specifies the version of the database engine.

func (*Snapshot) ID 

func (r *Snapshot) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*Snapshot) Iops 

func (r *Snapshot) Iops() *pulumi.IntOutput

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

func (*Snapshot) KmsKeyId 

func (r *Snapshot) KmsKeyId() *pulumi.StringOutput

The ARN for the KMS encryption key.

func (*Snapshot) LicenseModel 

func (r *Snapshot) LicenseModel() *pulumi.StringOutput

License model information for the restored DB instance.

func (*Snapshot) OptionGroupName 

func (r *Snapshot) OptionGroupName() *pulumi.StringOutput

Provides the option group name for the DB snapshot.

func (*Snapshot) Port 

func (r *Snapshot) Port() *pulumi.IntOutput

func (*Snapshot) SnapshotType 

func (r *Snapshot) SnapshotType() *pulumi.StringOutput

func (*Snapshot) SourceDbSnapshotIdentifier 

func (r *Snapshot) SourceDbSnapshotIdentifier() *pulumi.StringOutput

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

func (*Snapshot) SourceRegion 

func (r *Snapshot) SourceRegion() *pulumi.StringOutput

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

func (*Snapshot) Status 

func (r *Snapshot) Status() *pulumi.StringOutput

Specifies the status of this DB snapshot.

func (*Snapshot) StorageType 

func (r *Snapshot) StorageType() *pulumi.StringOutput

Specifies the storage type associated with DB snapshot.

func (*Snapshot) Tags added in v0.16.5 

func (r *Snapshot) Tags() *pulumi.MapOutput

Key-value mapping of resource tags

func (*Snapshot) URN 

func (r *Snapshot) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

func (*Snapshot) VpcId 

func (r *Snapshot) VpcId() *pulumi.StringOutput

Specifies the storage type associated with DB snapshot.

type SnapshotArgs 

type SnapshotArgs struct {
	// The DB Instance Identifier from which to take the snapshot.
	DbInstanceIdentifier interface{}
	// The Identifier for the snapshot.
	DbSnapshotIdentifier interface{}
	// Key-value mapping of resource tags
	Tags interface{}
}

The set of arguments for constructing a Snapshot resource.

type SnapshotState 

type SnapshotState struct {
	// Specifies the allocated storage size in gigabytes (GB).
	AllocatedStorage interface{}
	// Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
	AvailabilityZone interface{}
	// The DB Instance Identifier from which to take the snapshot.
	DbInstanceIdentifier interface{}
	// The Amazon Resource Name (ARN) for the DB snapshot.
	DbSnapshotArn interface{}
	// The Identifier for the snapshot.
	DbSnapshotIdentifier interface{}
	// Specifies whether the DB snapshot is encrypted.
	Encrypted interface{}
	// Specifies the name of the database engine.
	Engine interface{}
	// Specifies the version of the database engine.
	EngineVersion interface{}
	// Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
	Iops interface{}
	// The ARN for the KMS encryption key.
	KmsKeyId interface{}
	// License model information for the restored DB instance.
	LicenseModel interface{}
	// Provides the option group name for the DB snapshot.
	OptionGroupName interface{}
	Port            interface{}
	SnapshotType    interface{}
	// The DB snapshot Arn that the DB snapshot was copied from. It only has value in case of cross customer or cross region copy.
	SourceDbSnapshotIdentifier interface{}
	// The region that the DB snapshot was created in or copied from.
	SourceRegion interface{}
	// Specifies the status of this DB snapshot.
	Status interface{}
	// Specifies the storage type associated with DB snapshot.
	StorageType interface{}
	// Key-value mapping of resource tags
	Tags interface{}
	// Specifies the storage type associated with DB snapshot.
	VpcId interface{}
}

Input properties used for looking up and filtering Snapshot resources.

type SubnetGroup 

type SubnetGroup struct {
	// contains filtered or unexported fields
}

Provides an RDS DB subnet group resource.

func GetSubnetGroup 

func GetSubnetGroup(ctx *pulumi.Context,
	name string, id pulumi.ID, state *SubnetGroupState, opts ...pulumi.ResourceOpt) (*SubnetGroup, error)

GetSubnetGroup gets an existing SubnetGroup resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewSubnetGroup 

func NewSubnetGroup(ctx *pulumi.Context,
	name string, args *SubnetGroupArgs, opts ...pulumi.ResourceOpt) (*SubnetGroup, error)

NewSubnetGroup registers a new resource with the given unique name, arguments, and options.

func (*SubnetGroup) Arn 

func (r *SubnetGroup) Arn() *pulumi.StringOutput

The ARN of the db subnet group.

func (*SubnetGroup) Description 

func (r *SubnetGroup) Description() *pulumi.StringOutput

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

func (*SubnetGroup) ID 

func (r *SubnetGroup) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*SubnetGroup) Name 

func (r *SubnetGroup) Name() *pulumi.StringOutput

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

func (*SubnetGroup) NamePrefix 

func (r *SubnetGroup) NamePrefix() *pulumi.StringOutput

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

func (*SubnetGroup) SubnetIds 

func (r *SubnetGroup) SubnetIds() *pulumi.ArrayOutput

A list of VPC subnet IDs.

func (*SubnetGroup) Tags 

func (r *SubnetGroup) Tags() *pulumi.MapOutput

A mapping of tags to assign to the resource.

func (*SubnetGroup) URN 

func (r *SubnetGroup) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type SubnetGroupArgs 

type SubnetGroupArgs struct {
	// The description of the DB subnet group. Defaults to "Managed by Terraform".
	Description interface{}
	// The name of the DB subnet group. If omitted, Terraform will assign a random, unique name.
	Name interface{}
	// Creates a unique name beginning with the specified prefix. Conflicts with `name`.
	NamePrefix interface{}
	// A list of VPC subnet IDs.
	SubnetIds interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
}

The set of arguments for constructing a SubnetGroup resource.

type SubnetGroupState 

type SubnetGroupState struct {
	// The ARN of the db subnet group.
	Arn interface{}
	// The description of the DB subnet group. Defaults to "Managed by Terraform".
	Description interface{}
	// The name of the DB subnet group. If omitted, Terraform will assign a random, unique name.
	Name interface{}
	// Creates a unique name beginning with the specified prefix. Conflicts with `name`.
	NamePrefix interface{}
	// A list of VPC subnet IDs.
	SubnetIds interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
}

Input properties used for looking up and filtering SubnetGroup resources.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.