-
Notifications
You must be signed in to change notification settings - Fork 9.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #39438 from hashicorp/d-cdktf-docs-10985516841-109
cdktf: update documentation
- Loading branch information
Showing
52 changed files
with
3,174 additions
and
1,399 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
61 changes: 61 additions & 0 deletions
61
website/docs/cdktf/python/d/elasticache_reserved_cache_node_offering.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,61 @@ | ||
--- | ||
subcategory: "ElastiCache" | ||
layout: "aws" | ||
page_title: "AWS: aws_elasticache_reserved_cache_node_offering" | ||
description: |- | ||
Information about a single ElastiCache Reserved Cache Node Offering. | ||
--- | ||
|
||
|
||
<!-- Please do not edit this file, it is generated. --> | ||
# Data Source: aws_elasticache_reserved_cache_node_offering | ||
|
||
Information about a single ElastiCache Reserved Cache Node Offering. | ||
|
||
## Example Usage | ||
|
||
```python | ||
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug | ||
from constructs import Construct | ||
from cdktf import TerraformStack | ||
# | ||
# Provider bindings are generated by running `cdktf get`. | ||
# See https://cdk.tf/provider-generation for more details. | ||
# | ||
from imports.aws.data_aws_elasticache_reserved_cache_node_offering import DataAwsElasticacheReservedCacheNodeOffering | ||
class MyConvertedCode(TerraformStack): | ||
def __init__(self, scope, name): | ||
super().__init__(scope, name) | ||
DataAwsElasticacheReservedCacheNodeOffering(self, "example", | ||
cache_node_type="cache.t4g.small", | ||
duration="P1Y", | ||
offering_type="No Upfront", | ||
product_description="redis" | ||
) | ||
``` | ||
|
||
## Argument Reference | ||
|
||
The following arguments are supported: | ||
|
||
* `cache_node_type` - (Required) Node type for the reserved cache node. | ||
See AWS documentation for information on [supported node types for Redis](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html) and [guidance on selecting node types for Redis](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/nodes-select-size.html). | ||
See AWS documentation for information on [supported node types for Memcached](https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/CacheNodes.SupportedTypes.html) and [guidance on selecting node types for Memcached](https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/nodes-select-size.html). | ||
* `duration` - (Required) Duration of the reservation in RFC3339 duration format. | ||
Valid values are `P1Y` (one year) and `P3Y` (three years). | ||
* `offering_type` - (Required) Offering type of this reserved cache node. | ||
For the latest generation of nodes (e.g. M5, R5, T4 and newer) valid values are `No Upfront`, `Partial Upfront`, and `All Upfront`. | ||
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`. | ||
|
||
## Attribute Reference | ||
|
||
In addition to all arguments above, the following attributes are exported: | ||
|
||
* `id` - Unique identifier for the reservation. Same as `offering_id`. | ||
* `fixed_price` - Fixed price charged for this reserved cache node. | ||
* `offering_id` - Unique identifier for the reservation. | ||
|
||
<!-- cache-key: cdktf-0.20.1 input-965292cde7ab36b678077acfe62013d1655bf2d077c9b61c55be6121229ef30f --> |
65 changes: 65 additions & 0 deletions
65
...te/docs/cdktf/python/d/securityhub_standards_control_associations.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,65 @@ | ||
--- | ||
subcategory: "Security Hub" | ||
layout: "aws" | ||
page_title: "AWS: aws_securityhub_standards_control_associations" | ||
description: |- | ||
Terraform data source for managing an AWS Security Hub Standards Control Associations. | ||
--- | ||
|
||
|
||
<!-- Please do not edit this file, it is generated. --> | ||
# Resource: aws_securityhub_standards_control_associations | ||
|
||
Terraform data source for managing an AWS Security Hub Standards Control Associations. | ||
|
||
## Example Usage | ||
|
||
### Basic Usage | ||
|
||
```python | ||
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug | ||
from constructs import Construct | ||
from cdktf import TerraformStack | ||
# | ||
# Provider bindings are generated by running `cdktf get`. | ||
# See https://cdk.tf/provider-generation for more details. | ||
# | ||
from imports.aws.data_aws_securityhub_standards_control_associations import DataAwsSecurityhubStandardsControlAssociations | ||
from imports.aws.securityhub_account import SecurityhubAccount | ||
class MyConvertedCode(TerraformStack): | ||
def __init__(self, scope, name): | ||
super().__init__(scope, name) | ||
test = SecurityhubAccount(self, "test") | ||
data_aws_securityhub_standards_control_associations_test = | ||
DataAwsSecurityhubStandardsControlAssociations(self, "test_1", | ||
depends_on=[test], | ||
security_control_id="IAM.1" | ||
) | ||
# This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match. | ||
data_aws_securityhub_standards_control_associations_test.override_logical_id("test") | ||
``` | ||
|
||
## Argument Reference | ||
|
||
* `security_control_id` - (Required) The identifier of the control (identified with `SecurityControlId`, `SecurityControlArn`, or a mix of both parameters). | ||
|
||
## Attribute Reference | ||
|
||
This data source exports the following attributes in addition to the arguments above: | ||
|
||
* `standards_control_associations` - A list that provides the status and other details for each security control that applies to each enabled standard. | ||
See [`standards_control_associations`](#standards_control_associations-attribute-reference) below. | ||
|
||
### `standards_control_associations` Attribute Reference | ||
|
||
* `association_status` - Enablement status of a control in a specific standard. | ||
* `related_requirements` - List of underlying requirements in the compliance framework related to the standard. | ||
* `security_control_arn` - ARN of the security control. | ||
* `security_control_id` - ID of the security control. | ||
* `standards_arn` - ARN of the standard. | ||
* `standards_control_description` - Description of the standard. | ||
* `standards_control_title` - Title of the standard. | ||
* `updated_at` - Last time that a control's enablement status in a specified standard was updated. | ||
* `updated_reason` - Reason for updating a control's enablement status in a specified standard. | ||
|
||
<!-- cache-key: cdktf-0.20.1 input-c00380a89860eece1814ac9de7eefbb73fb280e1bf0a1078f9a81c54f1e95d9b --> |
77 changes: 77 additions & 0 deletions
77
website/docs/cdktf/python/d/synthetics_runtime_version.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,77 @@ | ||
--- | ||
subcategory: "CloudWatch Synthetics" | ||
layout: "aws" | ||
page_title: "AWS: aws_synthetics_runtime_version" | ||
description: |- | ||
Terraform data source for managing an AWS CloudWatch Synthetics Runtime Version. | ||
--- | ||
|
||
<!-- Please do not edit this file, it is generated. --> | ||
# Data Source: aws_synthetics_runtime_version | ||
|
||
Terraform data source for managing an AWS CloudWatch Synthetics Runtime Version. | ||
|
||
## Example Usage | ||
|
||
### Latest Runtime Version | ||
|
||
```python | ||
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug | ||
from constructs import Construct | ||
from cdktf import TerraformStack | ||
# | ||
# Provider bindings are generated by running `cdktf get`. | ||
# See https://cdk.tf/provider-generation for more details. | ||
# | ||
from imports.aws.data_aws_synthetics_runtime_version import DataAwsSyntheticsRuntimeVersion | ||
class MyConvertedCode(TerraformStack): | ||
def __init__(self, scope, name): | ||
super().__init__(scope, name) | ||
DataAwsSyntheticsRuntimeVersion(self, "example", | ||
latest=True, | ||
prefix="syn-nodejs-puppeteer" | ||
) | ||
``` | ||
|
||
### Specific Runtime Version | ||
|
||
```python | ||
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug | ||
from constructs import Construct | ||
from cdktf import TerraformStack | ||
# | ||
# Provider bindings are generated by running `cdktf get`. | ||
# See https://cdk.tf/provider-generation for more details. | ||
# | ||
from imports.aws.data_aws_synthetics_runtime_version import DataAwsSyntheticsRuntimeVersion | ||
class MyConvertedCode(TerraformStack): | ||
def __init__(self, scope, name): | ||
super().__init__(scope, name) | ||
DataAwsSyntheticsRuntimeVersion(self, "example", | ||
prefix="syn-nodejs-puppeteer", | ||
version="9.0" | ||
) | ||
``` | ||
|
||
## Argument Reference | ||
|
||
The following arguments are required: | ||
|
||
* `prefix` - (Required) Name prefix of the runtime version (for example, `syn-nodejs-puppeteer`). | ||
|
||
The following arguments are optional: | ||
|
||
* `latest` - (Optional) Whether the latest version of the runtime should be fetched. Conflicts with `version`. Valid values: `true`. | ||
* `version` - (Optional) Version of the runtime to be fetched (for example, `9.0`). Conflicts with `latest`. | ||
|
||
## Attribute Reference | ||
|
||
This data source exports the following attributes in addition to the arguments above: | ||
|
||
* `deprecation_date` - Date of deprecation if the runtme version is deprecated. | ||
* `description` - Description of the runtime version, created by Amazon. | ||
* `id` - Name of the runtime version. For a list of valid runtime versions, see [Canary Runtime Versions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html). | ||
* `release_date` - Date that the runtime version was released. | ||
* `version_name` - Name of the runtime version. For a list of valid runtime versions, see [Canary Runtime Versions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html). | ||
|
||
<!-- cache-key: cdktf-0.20.1 input-e6a2213fe4ac6a18145c981992f3636cc72cdc909368fb612d8d2484eadbec3d --> |
53 changes: 53 additions & 0 deletions
53
website/docs/cdktf/python/d/synthetics_runtime_versions.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,53 @@ | ||
--- | ||
subcategory: "CloudWatch Synthetics" | ||
layout: "aws" | ||
page_title: "AWS: aws_synthetics_runtime_versions" | ||
description: |- | ||
Terraform data source for managing an AWS CloudWatch Synthetics Runtime Versions. | ||
--- | ||
|
||
|
||
<!-- Please do not edit this file, it is generated. --> | ||
# Data Source: aws_synthetics_runtime_versions | ||
|
||
Terraform data source for managing an AWS CloudWatch Synthetics Runtime Versions. | ||
|
||
## Example Usage | ||
|
||
### Basic Usage | ||
|
||
```python | ||
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug | ||
from constructs import Construct | ||
from cdktf import TerraformStack | ||
# | ||
# Provider bindings are generated by running `cdktf get`. | ||
# See https://cdk.tf/provider-generation for more details. | ||
# | ||
from imports.aws.data_aws_synthetics_runtime_versions import DataAwsSyntheticsRuntimeVersions | ||
class MyConvertedCode(TerraformStack): | ||
def __init__(self, scope, name): | ||
super().__init__(scope, name) | ||
DataAwsSyntheticsRuntimeVersions(self, "example") | ||
``` | ||
|
||
## Argument Reference | ||
|
||
There are no arguments available for this data source. | ||
|
||
## Attribute Reference | ||
|
||
This data source exports the following attributes in addition to the arguments above: | ||
|
||
* `id` - Name of the AWS region from which runtime versions are fetched. | ||
* `runtime_versions` - List of runtime versions. See [`runtime_versions` attribute reference](#runtime_versions-attribute-reference). | ||
|
||
### `runtime_versions` Attribute Reference | ||
|
||
* `deprecation_date` - Date of deprecation if the runtme version is deprecated. | ||
* `description` - Description of the runtime version, created by Amazon. | ||
* `release_date` - Date that the runtime version was released. | ||
* `version_name` - Name of the runtime version. | ||
For a list of valid runtime versions, see [Canary Runtime Versions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html). | ||
|
||
<!-- cache-key: cdktf-0.20.1 input-e31363e80a8a71110dc91fea7ecab71b42bfd0014d1558a514d35963c2da5885 --> |
Oops, something went wrong.