Merge pull request #5725 from hashicorp/phinze/aws-aurora-db-subnet-group-name-docs
provider/aws: clarify `db_subnet_group_name` in Aurora docs
This commit is contained in:
commit
020e564dc7
|
@ -75,7 +75,7 @@ Default: A 30-minute window selected at random from an 8-hour block of time per
|
||||||
* `apply_immediately` - (Optional) Specifies whether any cluster modifications
|
* `apply_immediately` - (Optional) Specifies whether any cluster modifications
|
||||||
are applied immediately, or during the next maintenance window. Default is
|
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)
|
`false`. See [Amazon RDS Documentation for more information.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html)
|
||||||
* `db_subnet_group_name` - (Optional) A DB subnet group to associate with this DB instance.
|
* `db_subnet_group_name` - (Optional) 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`](/docs/providers/aws/r/rds_cluster_instance.html) in the cluster.
|
||||||
|
|
||||||
## Attributes Reference
|
## Attributes Reference
|
||||||
|
|
||||||
|
|
|
@ -49,9 +49,7 @@ The following arguments are supported:
|
||||||
|
|
||||||
* `identifier` - (Optional) The Instance Identifier. Must be a lower case
|
* `identifier` - (Optional) The Instance Identifier. Must be a lower case
|
||||||
string. If omitted, a unique identifier will be generated.
|
string. If omitted, a unique identifier will be generated.
|
||||||
* `cluster_identifier` - (Required) The Cluster Identifier for this Instance to
|
* `cluster_identifier` - (Required) The identifier of the [`aws_rds_cluster`](/docs/providers/aws/r/rds_cluster.html) in which to launch this instance.
|
||||||
join. Must be a lower case
|
|
||||||
string.
|
|
||||||
* `instance_class` - (Required) The instance class to use. For details on CPU
|
* `instance_class` - (Required) The instance class to use. For details on CPU
|
||||||
and memory, see [Scaling Aurora DB Instances][4]. Aurora currently
|
and memory, see [Scaling Aurora DB Instances][4]. Aurora currently
|
||||||
supports the below instance classes.
|
supports the below instance classes.
|
||||||
|
@ -63,10 +61,7 @@ and memory, see [Scaling Aurora DB Instances][4]. Aurora currently
|
||||||
* `publicly_accessible` - (Optional) Bool to control if instance is publicly accessible.
|
* `publicly_accessible` - (Optional) Bool to control if instance is publicly accessible.
|
||||||
Default `false`. See the documentation on [Creating DB Instances][6] for more
|
Default `false`. See the documentation on [Creating DB Instances][6] for more
|
||||||
details on controlling this property.
|
details on controlling this property.
|
||||||
|
* `db_subnet_group_name` - (Required if `publicly_accessible = false`, Optional otherwise) 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`](/docs/providers/aws/r/rds_cluster.html).
|
||||||
* `db_subnet_group_name` - (Optional) A DB subnet group to associate with this DB instance.
|
|
||||||
|
|
||||||
~> **NOTE:** `db_subnet_group_name` is a required field when you are trying to create a private instance (`publicly_accessible` = false)
|
|
||||||
|
|
||||||
## Attributes Reference
|
## Attributes Reference
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue