Skip to content

Commit

Permalink
Merge pull request hashicorp#39903 from hashicorp/d-cdktf-docs-115449…
Browse files Browse the repository at this point in the history
…86995-120

cdktf: update documentation
  • Loading branch information
ewbankkit authored Oct 28, 2024
2 parents d1a4b9b + 968360d commit f9b8d3a
Show file tree
Hide file tree
Showing 110 changed files with 1,270 additions and 307 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ class MyConvertedCode(TerraformStack):
def __init__(self, scope, name):
super().__init__(scope, name)
DataAwsConnectInstanceStorageConfig(self, "example",
association_id="1234567890123456789012345678901234567890123456789012345678901234",
association_id="1234567891234567890122345678912345678901223456789123456789012234",
instance_id="aaaaaaaa-bbbb-cccc-dddd-111111111111",
resource_type="CONTACT_TRACE_RECORDS"
)
Expand Down Expand Up @@ -93,4 +93,4 @@ The `encryption_config` configuration block supports the following arguments:
* `encryption_type` - The type of encryption. Valid Values: `KMS`.
* `key_id` - The full ARN of the encryption key. Be sure to provide the full ARN of the encryption key, not just the ID.

<!-- cache-key: cdktf-0.20.8 input-0a371661b1d38e2710e935ff6991b75943c6ddc01dc786ffa90e9554a47badeb -->
<!-- cache-key: cdktf-0.20.8 input-4f7f214db93fe3d98efd4b191b797a2b8d71b31f53ac2b9324e32c7a91225b12 -->
4 changes: 2 additions & 2 deletions website/docs/cdktf/python/d/ebs_volume.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ This data source exports the following attributes in addition to the arguments a

* `id` - Volume ID (e.g., vol-59fcb34e).
* `volume_id` - Volume ID (e.g., vol-59fcb34e).
* `arn` - Volume ARN (e.g., arn:aws:ec2:us-east-1:0123456789012:volume/vol-59fcb34e).
* `arn` - Volume ARN (e.g., arn:aws:ec2:us-east-1:123456789012:volume/vol-59fcb34e).
* `availability_zone` - AZ where the EBS volume exists.
* `encrypted` - Whether the disk is encrypted.
* `iops` - Amount of IOPS for the disk.
Expand All @@ -77,4 +77,4 @@ This data source exports the following attributes in addition to the arguments a

[1]: http://docs.aws.amazon.com/cli/latest/reference/ec2/describe-volumes.html

<!-- cache-key: cdktf-0.20.8 input-00c94bacdc21ca1f9f8c3f77dac8c937947e9644a5d93fbb88f378a86ec1420e -->
<!-- cache-key: cdktf-0.20.8 input-2cc3adf3199d31ab8dfeb5f2ca1f4ae71de63c586d192b6a6e0c20980731d176 -->
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ The following arguments are supported:
For other current generation nodes (i.e. T2, M3, M4, R3, or R4) the only valid value is `Heavy Utilization`.
For previous generation modes (i.e. T1, M1, M2, or C1) valid values are `Heavy Utilization`, `Medium Utilization`, and `Light Utilization`.
* `product_description` - (Required) Engine type for the reserved cache node.
Valid values are `redis` and `memcached`.
Valid values are `redis`, `valkey` and `memcached`.

## Attribute Reference

Expand All @@ -58,4 +58,4 @@ In addition to all arguments above, the following attributes are exported:
* `fixed_price` - Fixed price charged for this reserved cache node.
* `offering_id` - Unique identifier for the reservation.

<!-- cache-key: cdktf-0.20.8 input-965292cde7ab36b678077acfe62013d1655bf2d077c9b61c55be6121229ef30f -->
<!-- cache-key: cdktf-0.20.8 input-5295ba7c1a9cdc8e160feb33e78743925ce9e905a56917f4dc0ad1eb813e35c8 -->
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ This data source exports the following attributes in addition to the arguments a
* `arn` - The Amazon Resource Name (ARN) of the serverless cache.
* `cache_usage_limits` - The cache usage limits for storage and ElastiCache Processing Units for the cache. See [`cache_usage_limits` Block](#cache_usage_limits-block) for details.
* `create_time` - Timestamp of when the serverless cache was created.
* `daily_snapshot_time` - The daily time that snapshots will be created from the new serverless cache. Only available for engine type `"redis"`.
* `daily_snapshot_time` - The daily time that snapshots will be created from the new serverless cache. Only available for engine types `"redis"` and `"valkey"`.
* `description` - Description of the serverless cache.
* `endpoint` - Represents the information required for client programs to connect to the cache. See [`endpoint` Block](#endpoint-block) for details.
* `engine` – Name of the cache engine.
Expand Down Expand Up @@ -94,4 +94,4 @@ The `reader_endpoint` block exports the following attributes:
* `address` - The DNS hostname of the cache node.
* `port` - The port number that the cache engine is listening on. Set as integer.

<!-- cache-key: cdktf-0.20.8 input-99589d80b7665c494d09cff80a173b45dc31fc47d5cda81717cdcfaf99723938 -->
<!-- cache-key: cdktf-0.20.8 input-d2aefac0ebbbe62167539f079f29f724c5f6b79e6dc1f34257d5078b71badbe1 -->
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,15 @@ The following arguments are optional:
This data source exports the following attributes in addition to the arguments above:

* `admins` – List of ARNs of AWS Lake Formation principals (IAM users or roles).
* `read_only_admins` – List of ARNs of AWS Lake Formation principals (IAM users or roles) with only view access to the resources.
* `allow_external_data_filtering` - Whether to allow Amazon EMR clusters to access data managed by Lake Formation.
* `allow_full_table_external_data_access` - Whether to allow a third-party query engine to get data access credentials without session tags when a caller has full data access permissions.
* `authorized_session_tag_value_list` - Lake Formation relies on a privileged process secured by Amazon EMR or the third party integrator to tag the user's role while assuming it.
* `create_database_default_permissions` - Up to three configuration blocks of principal permissions for default create database permissions. Detailed below.
* `create_table_default_permissions` - Up to three configuration blocks of principal permissions for default create table permissions. Detailed below.
* `trusted_resource_owners` – List of the resource-owning account IDs that the caller's account can use to share their user access details (user ARNs).
* `allow_external_data_filtering` - Whether to allow Amazon EMR clusters to access data managed by Lake Formation.
* `external_data_filtering_allow_list` - A list of the account IDs of Amazon Web Services accounts with Amazon EMR clusters that are to perform data filtering.
* `authorized_session_tag_value_list` - Lake Formation relies on a privileged process secured by Amazon EMR or the third party integrator to tag the user's role while assuming it.
* `allow_full_table_external_data_access` - Whether to allow a third-party query engine to get data access credentials without session tags when a caller has full data access permissions.
* `parameters` - Key-value map of additional configuration. `CROSS_ACCOUNT_VERSION` will be set to values `"1"`, `"2"`, `"3"`, or `"4"`. `SET_CONTEXT` will also be returned with a value of `TRUE`. In a fresh account, prior to configuring, `CROSS_ACCOUNT_VERSION` is `"1"`.
* `read_only_admins` – List of ARNs of AWS Lake Formation principals (IAM users or roles) with only view access to the resources.
* `trusted_resource_owners` – List of the resource-owning account IDs that the caller's account can use to share their user access details (user ARNs).

### create_database_default_permissions

Expand All @@ -61,4 +62,4 @@ This data source exports the following attributes in addition to the arguments a
* `permissions` - List of permissions granted to the principal.
* `principal` - Principal who is granted permissions.

<!-- cache-key: cdktf-0.20.8 input-955d0382f00ca6707e1e798219a00eaad68e2dd3fc8389b5db46f0a22216a91e -->
<!-- cache-key: cdktf-0.20.8 input-51d5ef0991ff9f9f62fd44fce192e2952d488ac5375672a447fb28945c1fc986 -->
188 changes: 188 additions & 0 deletions website/docs/cdktf/python/d/lb_listener_rule.html.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,188 @@
---
subcategory: "ELB (Elastic Load Balancing)"
layout: "aws"
page_title: "AWS: aws_lb_listener_rule"
description: |-
Terraform data source for managing an AWS ELB (Elastic Load Balancing) Listener Rule.
---


<!-- Please do not edit this file, it is generated. -->
# Data Source: aws_lb_listener_rule

Provides information about an AWS Elastic Load Balancing Listener Rule.

## Example Usage

### Match by Rule ARN

```python
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import VariableType, TerraformVariable, TerraformStack
#
# Provider bindings are generated by running `cdktf get`.
# See https://cdk.tf/provider-generation for more details.
#
from imports.aws. import DataAwsLbListenerRule
class MyConvertedCode(TerraformStack):
def __init__(self, scope, name):
super().__init__(scope, name)
# Terraform Variables are not always the best fit for getting inputs in the context of Terraform CDK.
# You can read more about this at https://cdk.tf/variables
lb_rule_arn = TerraformVariable(self, "lb_rule_arn",
type=VariableType.STRING
)
DataAwsLbListenerRule(self, "example",
arn=lb_rule_arn.value
)
```

### Match by Listener ARN and Priority

```python
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import VariableType, TerraformVariable, TerraformStack
#
# Provider bindings are generated by running `cdktf get`.
# See https://cdk.tf/provider-generation for more details.
#
from imports.aws. import DataAwsLbListenerRule
class MyConvertedCode(TerraformStack):
def __init__(self, scope, name):
super().__init__(scope, name)
# Terraform Variables are not always the best fit for getting inputs in the context of Terraform CDK.
# You can read more about this at https://cdk.tf/variables
lb_listener_arn = TerraformVariable(self, "lb_listener_arn",
type=VariableType.STRING
)
lb_rule_priority = TerraformVariable(self, "lb_rule_priority",
type=VariableType.NUMBER
)
DataAwsLbListenerRule(self, "example",
listener_arn=lb_listener_arn.value,
priority=lb_rule_priority.value
)
```

## Argument Reference

This data source supports the following arguments:

* `arn` - (Optional) ARN of the Listener Rule.
Either `arn` or `listener_arn` must be set.
* `listener_arn` - (Optional) ARN of the associated Listener.
Either `arn` or `listener_arn` must be set.
* `priority` - (Optional) Priority of the Listener Rule within the Listener.
Must be set if `listener_arn` is set, otherwise must not be set.

## Attribute Reference

This data source exports the following attributes in addition to the arguments above:

* `action` - List of actions associated with the rule, sorted by `order`.
[Detailed below](#action).
* `condition` - Set of conditions associated with the rule.
[Detailed below](#condition).
* `tags` - Tags assigned to the Listener Rule.

### `action`

* `type` - The type of the action, indicates which sub-block will be populated.
* `order` - The evaluation order of the action.
* `authenticate_cognito` - An action to authenticate using Amazon Cognito.
[Detailed below](#authenticate_cognito).
* `authenticate_oidc` - An action to authenticate using OIDC.
[Detailed below](#authenticate_oidc).
* `fixed_response` - An action to return a fixed response.
[Detailed below](#fixed_response).
* `forward` - An action to forward the request.
[Detailed below](#forward).
* `redirect` - An action to redirect the request.
[Detailed below](#redirect).

#### `authenticate_cognito`

* `authentication_request_extra_params` - Set of additional parameters for the request.
[Detailed below](#authentication_request_extra_params).
* `on_unauthenticated_request` - Behavior when the client is not authenticated.
* `scope` - Set of user claims requested.
* `session_cookie_name` - Name of the cookie used to maintain session information.
* `session_timeout` - Maximum duration of the authentication session in seconds.
* `user_pool_arn` - ARN of the Cognito user pool.
* `user_pool_client_id` - ID of the Cognito user pool client.
* `user_pool_domain` - Domain prefix or fully-qualified domain name of the Cognito user pool.

#### `authenticate_oidc`

* `authentication_request_extra_params` - Set of additional parameters for the request.
[Detailed below](#authentication_request_extra_params).
* `authorization_endpoint` - The authorization endpoint of the IdP.
* `client_id` - OAuth 2.0 client identifier.
* `issuer` - OIDC issuer identifier of the IdP.
* `on_unauthenticated_request` - Behavior when the client is not authenticated.
* `scope` - Set of user claims requested.
* `session_cookie_name` - Name of the cookie used to maintain session information.
* `session_timeout` - Maximum duration of the authentication session in seconds.
* `token_endpoint` - The token endpoint of the IdP.
* `user_info_endpoint` - The user info endpoint of the IdP.

#### `authentication_request_extra_params`

* `key` - Key of query parameter
* `value` - Value of query parameter

#### `fixed_response`

* `content_type` - Content type of the response.
* `message_body` - Message body of the response.
* `status_code` - HTTP response code of the response.

#### `forward`

* `stickiness` - Target group stickiness for the rule.
[Detailed below](#stickiness).
* `target_group` - Set of target groups for the action.
[Detailed below](#target_group).

#### `stickiness`

* `duration` - The time period, in seconds, during which requests from a client should be routed to the same target group.
* `enabled` - Indicates whether target group stickiness is enabled.

#### `target_group`

* `arn` - ARN of the target group.
* `weight` - Weight of the target group.

#### `redirect`

* `host` - The hostname.
* `path` - The absolute path, starting with `/`.
* `port` - The port.
* `protocol` - The protocol.
* `query` - The query parameters.
* `status_code` - The HTTP redirect code.

### `condition`

* `host_header` - Contains a single attribute `values`, which contains a set of host names.
* `http_header` - HTTP header and values to match.
[Detailed below](#http_header).
* `http_request_method` - Contains a single attribute `values`, which contains a set of HTTP request methods.
* `path_pattern` - Contains a single attribute `values`, which contains a set of path patterns to compare against the request URL.
* `query_string` - Query string parameters to match.
[Detailed below](#query_string).
* `source_ip` - Contains a single attribute `values`, which contains a set of source IPs in CIDR notation.

#### `http_header`

* `http_header_name` - Name of the HTTP header to match.
* `values` - Set of values to compare against the value of the HTTP header.

#### `query_string`

* `values` - Set of `key`-`value` pairs indicating the query string parameters to match.

<!-- cache-key: cdktf-0.20.8 input-9f870f9901fed900e71a95bad27ee1faac26237d58f4a32678370950d3af6c88 -->
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,6 @@ The following arguments are available:
* `conditions` (Required) - A block argument. Detailed Below.
* `description` (Optional) - A user-defined description that further helps identify the rule.
* `rule_number` (Required) - An integer from `1` to `65535` indicating the rule's order number. Rules are processed in order from the lowest numbered rule to the highest. Rules stop processing when a rule is matched. It's important to make sure that you number your rules in the exact order that you want them processed.
* `add_to_network_function_group` (Optional) - The name of the network function group to attach to the attachment policy.

### `action`

Expand Down Expand Up @@ -282,4 +281,4 @@ This data source exports the following attributes in addition to the arguments a

* `json` - Standard JSON policy document rendered based on the arguments above.

<!-- cache-key: cdktf-0.20.8 input-a2e47b27cd0f34515d6ff9e64919da142c3a0f9864d63577b9ebaa20c8610392 -->
<!-- cache-key: cdktf-0.20.8 input-4c6cfeac554a14d39a0738c63e288695b2b0893217ff2d03c14216cf8f26cb04 -->
4 changes: 2 additions & 2 deletions website/docs/cdktf/python/d/shield_protection.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ class MyConvertedCode(TerraformStack):
def __init__(self, scope, name):
super().__init__(scope, name)
DataAwsShieldProtection(self, "example",
resource_arn="arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh"
resource_arn="arn:aws:globalaccelerator::123456789012:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh"
)
```

Expand All @@ -68,4 +68,4 @@ This data source exports the following attributes in addition to the arguments a
* `name` - Name of the protection.
* `protection_arn` - ARN of the protection.

<!-- cache-key: cdktf-0.20.8 input-75d9f856f14ca87d032548d9404cb36b20ed94a40ec416924f4ee0c3392a6e12 -->
<!-- cache-key: cdktf-0.20.8 input-59de3a79156bc1c7c56349a69033dc1dcd795ab4a1f865d892748664811bc987 -->
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ class MyConvertedCode(TerraformStack):
def __init__(self, scope, name):
super().__init__(scope, name)
DataAwsSsoadminApplication(self, "example",
application_arn="arn:aws:sso::012345678901:application/ssoins-1234/apl-5678"
application_arn="arn:aws:sso::123456789012:application/ssoins-1234/apl-5678"
)
```

Expand All @@ -52,4 +52,4 @@ This data source exports the following attributes in addition to the arguments a
* `portal_options` - Options for the portal associated with an application. See the `aws_ssoadmin_application` [resource documentation](../r/ssoadmin_application.html.markdown#portal_options-argument-reference). The attributes are the same.
* `status` - Status of the application.

<!-- cache-key: cdktf-0.20.8 input-0d07cfe6432527b9115d7fc49e2aad9b81dacbb2fee9606812ff5efd006c2f93 -->
<!-- cache-key: cdktf-0.20.8 input-b8096210ea51a9d18e70341d363454abfccc3d45f7f56956f44ea2603393947a -->
4 changes: 2 additions & 2 deletions website/docs/cdktf/python/index.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Use the Amazon Web Services (AWS) provider to interact with the
many resources supported by AWS. You must configure the provider
with the proper credentials before you can use it.

Use the navigation to the left to read about the available resources. There are currently 1439 resources and 588 data sources available in the provider.
Use the navigation to the left to read about the available resources. There are currently 1441 resources and 588 data sources available in the provider.

To learn the basics of Terraform using this provider, follow the
hands-on [get started tutorials](https://learn.hashicorp.com/tutorials/terraform/infrastructure-as-code?in=terraform/aws-get-started&utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS). Interact with AWS services,
Expand Down Expand Up @@ -898,4 +898,4 @@ Approaches differ per authentication providers:
There used to be no better way to get account ID out of the API
when using the federated account until `sts:GetCallerIdentity` was introduced.

<!-- cache-key: cdktf-0.20.8 input-ab653be2874be3b5f074c531510a036efdaa6a3e65169c58221c9785f67e5110 -->
<!-- cache-key: cdktf-0.20.8 input-e8316543776db5dd08403a4df7629bf9aa7b8451abae62db6544444045e878d6 -->
3 changes: 1 addition & 2 deletions website/docs/cdktf/python/r/ami_copy.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ class MyConvertedCode(TerraformStack):
def __init__(self, scope, name):
super().__init__(scope, name)
AmiCopy(self, "example",
description="A copy of ami-xxxxxxxx",
name="terraform-example",
source_ami_id="ami-xxxxxxxx",
source_ami_region="us-west-1",
Expand Down Expand Up @@ -83,4 +82,4 @@ configuration.
* `update` - (Default `40m`)
* `delete` - (Default `90m`)

<!-- cache-key: cdktf-0.20.8 input-24f70ab5d03ce5421bd9ce27fd5b5602c0ac4eedfab0b82ddfc7fec0c10806cf -->
<!-- cache-key: cdktf-0.20.8 input-d5fcd6011bb66e5d779ef5d7339819041b38b36d03570590f8e5ea6b0b071e1a -->
Loading

0 comments on commit f9b8d3a

Please sign in to comment.