55 lines
1.5 KiB
Markdown
55 lines
1.5 KiB
Markdown
|
---
|
||
|
|
layout: "aws"
|
||
|
|
page_title: "AWS: aws_region"
|
||
|
|
sidebar_current: "docs-aws-datasource-region"
|
||
|
|
description: |-
|
||
|
|
Provides details about a specific service region
|
||
|
|
---
|
||
|
|
|
||
|
|
# aws\_region
|
||
|
|
|
||
|
|
`aws_region` provides details about a specific AWS region.
|
||
|
|
|
||
|
|
As well as validating a given region name (and optionally obtaining its
|
||
|
|
endpoint) this resource can be used to discover the name of the region
|
||
|
|
configured within the provider. The latter can be useful in a child module
|
||
|
|
which is inheriting an AWS provider configuration from its parent module.
|
||
|
|
|
||
|
|
## Example Usage
|
||
|
|
|
||
|
|
The following example shows how the resource might be used to obtain
|
||
|
|
the name of the AWS region configured on the provider.
|
||
|
|
|
||
|
|
```
|
||
|
|
data "aws_region" "current" {
|
||
|
|
current = true
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
## Argument Reference
|
||
|
|
|
||
|
|
The arguments of this data source act as filters for querying the available
|
||
|
|
regions. The given filters must match exactly one region whose data will be
|
||
|
|
exported as attributes.
|
||
|
|
|
||
|
|
* `name` - (Optional) The full name of the region to select.
|
||
|
|
|
||
|
|
* `current` - (Optional) Set to `true` to match only the region configured
|
||
|
|
in the provider. (It is not meaningful to set this to `false`.)
|
||
|
|
|
||
|
|
* `endpoint` - (Optional) The endpoint of the region to select.
|
||
|
|
|
||
|
|
At least one of the above attributes should be provided to ensure that only
|
||
|
|
one region is matched.
|
||
|
|
|
||
|
|
## Attributes Reference
|
||
|
|
|
||
|
|
The following attributes are exported:
|
||
|
|
|
||
|
|
* `name` - The name of the selected region.
|
||
|
|
|
||
|
|
* `current` - `true` if the selected region is the one configured on the
|
||
|
|
provider, or `false` otherwise.
|
||
|
|
|
||
|
|
* `endpoint` - The endpoint for the selected region.
|