forked from hashicorp/terraform-provider-aws
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add CDKTF documentation for
ec2_*
resources/datasource and up…
…date script (hashicorp#31596) * chore: add PR based workflow for cdktf docs * docs: update cdktf documentation * chore: update dependencies * chore: add ignore flag * chore: pin github action versions * chore: run go mod tidy * chore: don't use version detection anymore
- Loading branch information
1 parent
c0c2827
commit d964108
Showing
160 changed files
with
11,290 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
name: CDKTF Documentation | ||
on: | ||
schedule: | ||
- cron: "0 0 * * WED" | ||
workflow_dispatch: {} | ||
|
||
permissions: | ||
contents: write | ||
pull-requests: write | ||
|
||
jobs: | ||
cdktfDocs: | ||
runs-on: ubuntu-latest | ||
container: | ||
image: docker.mirror.hashicorp.services/hashicorp/jsii-terraform | ||
env: | ||
CHECKPOINT_DISABLE: "1" | ||
timeout-minutes: 120 | ||
steps: | ||
- uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3.5.2 | ||
- run: git config --global user.email "[email protected]" | ||
- run: git config --global user.name "team-tf-cdk" | ||
- name: Get yarn cache directory path | ||
id: global-cache-dir-path | ||
run: echo "dir=$(yarn cache dir)" >> $GITHUB_OUTPUT | ||
- uses: actions/cache@88522ab9f39a2ea568f7027eddc7d8d8bc9d59c8 # v3.3.1 | ||
id: global-cache | ||
with: | ||
path: ${{ steps.global-cache-dir-path.outputs.dir }} | ||
key: ${{ runner.os }}-integration-yarn-${{ hashFiles('**/yarn.lock') }} | ||
- name: Setup Node.js | ||
uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3.6.0 | ||
with: | ||
node-version: "18.x" | ||
- name: Install cdktf-registry-docs | ||
run: npm install -g [email protected] | ||
- name: Run conversion | ||
run: | | ||
cdktf-registry-docs convert \ | ||
--files='*/ec2_*.html.markdown' \ | ||
--languages='typescript,python' \ | ||
--parallel-conversions-per-document=1 \ | ||
--provider-from-registry="hashicorp/aws" \ | ||
. | ||
env: | ||
TF_PLUGIN_CACHE_DIR: ${{ steps.global-cache-dir-path.outputs.dir }}/terraform-plugins | ||
|
||
- name: Create Pull Request | ||
uses: peter-evans/create-pull-request@284f54f989303d2699d373481a0cfa13ad5a6666 # v5.0.1 | ||
with: | ||
commit-message: "docs: update cdktf documentation" | ||
title: "docs: update cdktf documentation" | ||
body: "This PR updates the cdktf related documentation based on the current HCL-based documentation. It is automatically created by the cdktf-documentation GitHub action." |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
96 changes: 96 additions & 0 deletions
96
website/docs/cdktf/python/d/ec2_client_vpn_endpoint.html.markdown
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,96 @@ | ||
--- | ||
subcategory: "VPN (Client)" | ||
layout: "aws" | ||
page_title: "AWS: aws_ec2_client_vpn_endpoint" | ||
description: |- | ||
Get information on an EC2 Client VPN endpoint | ||
--- | ||
|
||
# Data Source: aws_ec2_client_vpn_endpoint | ||
|
||
Get information on an EC2 Client VPN endpoint. | ||
|
||
## Example Usage | ||
|
||
### By Filter | ||
|
||
```python | ||
import constructs as constructs | ||
import cdktf as cdktf | ||
# Provider bindings are generated by running cdktf get. | ||
# See https://cdk.tf/provider-generation for more details. | ||
import ...gen.providers.aws as aws | ||
class MyConvertedCode(cdktf.TerraformStack): | ||
def __init__(self, scope, name): | ||
super().__init__(scope, name) | ||
aws.data_aws_ec2_client_vpn_endpoint.DataAwsEc2ClientVpnEndpoint(self, "example", | ||
filter=[DataAwsEc2ClientVpnEndpointFilter( | ||
name="tag:Name", | ||
values=["ExampleVpn"] | ||
) | ||
] | ||
) | ||
``` | ||
|
||
### By Identifier | ||
|
||
```python | ||
import constructs as constructs | ||
import cdktf as cdktf | ||
# Provider bindings are generated by running cdktf get. | ||
# See https://cdk.tf/provider-generation for more details. | ||
import ...gen.providers.aws as aws | ||
class MyConvertedCode(cdktf.TerraformStack): | ||
def __init__(self, scope, name): | ||
super().__init__(scope, name) | ||
aws.data_aws_ec2_client_vpn_endpoint.DataAwsEc2ClientVpnEndpoint(self, "example", | ||
client_vpn_endpoint_id="cvpn-endpoint-083cf50d6eb314f21" | ||
) | ||
``` | ||
|
||
## Argument Reference | ||
|
||
The following arguments are supported: | ||
|
||
* `client_vpn_endpoint_id` - (Optional) ID of the Client VPN endpoint. | ||
* `filter` - (Optional) One or more configuration blocks containing name-values filters. Detailed below. | ||
* `tags` - (Optional) Map of tags, each pair of which must exactly match a pair on the desired endpoint. | ||
|
||
### filter | ||
|
||
This block allows for complex filters. You can use one or more `filter` blocks. | ||
|
||
The following arguments are required: | ||
|
||
* `name` - (Required) Name of the field to filter by, as defined by [the underlying AWS API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeClientVpnEndpoints.html). | ||
* `values` - (Required) Set of values that are accepted for the given field. An endpoint will be selected if any one of the given values matches. | ||
|
||
## Attribute Reference | ||
|
||
In addition to all arguments above, the following attributes are exported: | ||
|
||
* `arn` - The ARN of the Client VPN endpoint. | ||
* `authentication_options` - Information about the authentication method used by the Client VPN endpoint. | ||
* `client_cidr_block` - IPv4 address range, in CIDR notation, from which client IP addresses are assigned. | ||
* `client_connect_options` - The options for managing connection authorization for new client connections. | ||
* `client_login_banner_options` - Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established. | ||
* `connection_log_options` - Information about the client connection logging options for the Client VPN endpoint. | ||
* `description` - Brief description of the endpoint. | ||
* `dns_name` - DNS name to be used by clients when connecting to the Client VPN endpoint. | ||
* `dns_servers` - Information about the DNS servers to be used for DNS resolution. | ||
* `security_group_ids` - IDs of the security groups for the target network associated with the Client VPN endpoint. | ||
* `self_service_portal` - Whether the self-service portal for the Client VPN endpoint is enabled. | ||
* `server_certificate_arn` - The ARN of the server certificate. | ||
* `session_timeout_hours` - The maximum VPN session duration time in hours. | ||
* `split_tunnel` - Whether split-tunnel is enabled in the AWS Client VPN endpoint. | ||
* `transport_protocol` - Transport protocol used by the Client VPN endpoint. | ||
* `vpc_id` - ID of the VPC associated with the Client VPN endpoint. | ||
* `vpn_port` - Port number for the Client VPN endpoint. | ||
|
||
## Timeouts | ||
|
||
[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): | ||
|
||
- `read` - (Default `20m`) | ||
|
||
<!-- cache-key: cdktf-0.17.0-pre.15 input-86166d26a95ae3c88a4d4e7f8804306d48860395f262b9f351921ba97ba82ccc --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
--- | ||
subcategory: "Outposts (EC2)" | ||
layout: "aws" | ||
page_title: "AWS: aws_ec2_coip_pool" | ||
description: |- | ||
Provides details about a specific EC2 Customer-Owned IP Pool | ||
--- | ||
|
||
# Data Source: aws_ec2_coip_pool | ||
|
||
Provides details about a specific EC2 Customer-Owned IP Pool. | ||
|
||
This data source can prove useful when a module accepts a coip pool id as | ||
an input variable and needs to, for example, determine the CIDR block of that | ||
COIP Pool. | ||
|
||
## Example Usage | ||
|
||
The following example returns a specific coip pool ID | ||
|
||
```terraform | ||
variable "coip_pool_id" {} | ||
data "aws_ec2_coip_pool" "selected" { | ||
id = var.coip_pool_id | ||
} | ||
``` | ||
|
||
## Argument Reference | ||
|
||
The arguments of this data source act as filters for querying the available | ||
COIP Pools in the current region. The given filters must match exactly one | ||
COIP Pool whose data will be exported as attributes. | ||
|
||
* `local_gateway_route_table_id` - (Optional) Local Gateway Route Table Id assigned to desired COIP Pool | ||
|
||
* `pool_id` - (Optional) ID of the specific COIP Pool to retrieve. | ||
|
||
* `tags` - (Optional) Mapping of tags, each pair of which must exactly match | ||
a pair on the desired COIP Pool. | ||
|
||
More complex filters can be expressed using one or more `filter` sub-blocks, | ||
which take the following arguments: | ||
|
||
* `name` - (Required) Name of the field to filter by, as defined by | ||
[the underlying AWS API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeCoipPools.html). | ||
|
||
* `values` - (Required) Set of values that are accepted for the given field. | ||
A COIP Pool will be selected if any one of the given values matches. | ||
|
||
## Attributes Reference | ||
|
||
All of the argument attributes except `filter` blocks are also exported as | ||
result attributes. This data source will complete the data by populating | ||
any fields that are not included in the configuration with the data for | ||
the selected COIP Pool. | ||
|
||
In addition, the following attributes are exported: | ||
|
||
* `arn` - ARN of the COIP pool | ||
* `pool_cidrs` - Set of CIDR blocks in pool | ||
|
||
## Timeouts | ||
|
||
[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): | ||
|
||
- `read` - (Default `20m`) | ||
|
||
<!-- cache-key: cdktf-0.17.0-pre.15 input-4018a02fb3e3ba399170a12145e567c04dd4dcf3d3de820650bd0da4b7852ab7 --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
--- | ||
subcategory: "Outposts (EC2)" | ||
layout: "aws" | ||
page_title: "AWS: aws_ec2_coip_pools" | ||
description: |- | ||
Provides information for multiple EC2 Customer-Owned IP Pools | ||
--- | ||
|
||
# Data Source: aws_ec2_coip_pools | ||
|
||
Provides information for multiple EC2 Customer-Owned IP Pools, such as their identifiers. | ||
|
||
## Example Usage | ||
|
||
The following shows outputting all COIP Pool Ids. | ||
|
||
```terraform | ||
data "aws_ec2_coip_pools" "foo" {} | ||
output "foo" { | ||
value = data.aws_ec2_coip_pools.foo.ids | ||
} | ||
``` | ||
|
||
## Argument Reference | ||
|
||
* `tags` - (Optional) Mapping of tags, each pair of which must exactly match | ||
a pair on the desired aws_ec2_coip_pools. | ||
|
||
* `filter` - (Optional) Custom filter block as described below. | ||
|
||
More complex filters can be expressed using one or more `filter` sub-blocks, | ||
which take the following arguments: | ||
|
||
* `name` - (Required) Name of the field to filter by, as defined by | ||
[the underlying AWS API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeCoipPools.html). | ||
|
||
* `values` - (Required) Set of values that are accepted for the given field. | ||
A COIP Pool will be selected if any one of the given values matches. | ||
|
||
## Attributes Reference | ||
|
||
* `id` - AWS Region. | ||
* `pool_ids` - Set of COIP Pool Identifiers | ||
|
||
## Timeouts | ||
|
||
[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): | ||
|
||
- `read` - (Default `20m`) | ||
|
||
<!-- cache-key: cdktf-0.17.0-pre.15 input-c1c9a426e16105b7a02e1c1b1adc831132ac241239b921ea8b6a60157547ed64 --> |
Oops, something went wrong.