Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cdktf: update documentation #37145

Merged
merged 1 commit into from
Apr 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,8 @@ Each document configuration may have one or more `rule` blocks, which each accep
* `priority` (Required) - Sets the order in which rules are evaluated, lowest to highest. When you add rules to a lifecycle policy, you must give them each a unique value for `priority`. Values do not need to be sequential across rules in a policy. A rule with a `tag_status` value of any must have the highest value for `priority` and be evaluated last.
* `selection` (Required) - Collects parameters describing the selection criteria for the ECR lifecycle policy:
* `tag_status` (Required) - Determines whether the lifecycle policy rule that you are adding specifies a tag for an image. Acceptable options are tagged, untagged, or any. If you specify any, then all images have the rule applied to them. If you specify tagged, then you must also specify a `tag_prefix_list` value. If you specify untagged, then you must omit `tag_prefix_list`.
* `tag_prefix_list` (Required if `tag_status` is set to tagged) - You must specify a comma-separated list of image tag prefixes on which to take action with your lifecycle policy. For example, if your images are tagged as prod, prod1, prod2, and so on, you would use the tag prefix prod to specify all of them. If you specify multiple tags, only images with all specified tags are selected.
* `tag_pattern_list` (Required if `tag_status` is set to tagged and `tag_prefix_list` isn't specified) - You must specify a comma-separated list of image tag patterns that may contain wildcards (*) on which to take action with your lifecycle policy. For example, if your images are tagged as prod, prod1, prod2, and so on, you would use the tag pattern list prod* to specify all of them. If you specify multiple tags, only the images with all specified tags are selected. There is a maximum limit of four wildcards (*) per string. For example, ["*test*1*2*3", "test*1*2*3*"] is valid but ["test*1*2*3*4*5*6"] is invalid.
* `tag_prefix_list` (Required if `tag_status` is set to tagged and `tag_pattern_list` isn't specified) - You must specify a comma-separated list of image tag prefixes on which to take action with your lifecycle policy. For example, if your images are tagged as prod, prod1, prod2, and so on, you would use the tag prefix prod to specify all of them. If you specify multiple tags, only images with all specified tags are selected.
* `count_type` (Required) - Specify a count type to apply to the images. If `count_type` is set to imageCountMoreThan, you also specify `count_number` to create a rule that sets a limit on the number of images that exist in your repository. If `count_type` is set to sinceImagePushed, you also specify `count_unit` and `count_number` to specify a time limit on the images that exist in your repository.
* `count_unit` (Required if `count_type` is set to sinceImagePushed) - Specify a count unit of days to indicate that as the unit of time, in addition to `count_number`, which is the number of days.
* `count_number` (Required) - Specify a count number. If the `count_type` used is imageCountMoreThan, then the value is the maximum number of images that you want to retain in your repository. If the `count_type` used is sinceImagePushed, then the value is the maximum age limit for your images.
Expand All @@ -74,4 +75,4 @@ This data source exports the following attributes in addition to the arguments a

* `json` - The above arguments serialized as a standard JSON policy document.

<!-- cache-key: cdktf-0.20.1 input-d6058e0510becef36f0ccccb222d04c53970d90287457850b97fb1deca294148 -->
<!-- cache-key: cdktf-0.20.1 input-75182ef7152aaa6cce22d6cf722fdf5a91a35ff727574047101fd54d8ca3ae5b -->
10 changes: 5 additions & 5 deletions website/docs/cdktf/python/d/memorydb_user.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,9 @@ This data source exports the following attributes in addition to the arguments a
* `access_string` - Access permissions string used for this user.
* `arn` - ARN of the user.
* `authentication_mode` - Denotes the user's authentication properties.
* `password_count` - The number of passwords belonging to the user.
* `type` - Whether the user requires a password to authenticate.
* `minimum_engine_version` - The minimum engine version supported for the user.
* `tags` - Map of tags assigned to the subnet group.
* `password_count` - Number of passwords belonging to the user if `type` is set to `password`.
* `type` - Type of authentication configured.
* `minimum_engine_version` - Minimum engine version supported for the user.
* `tags` - Map of tags assigned to the user.

<!-- cache-key: cdktf-0.20.1 input-c6f19bc84dfa577edf03fcc5ca3f615821c417f424a780c64de232dacc41af5a -->
<!-- cache-key: cdktf-0.20.1 input-96e6cd20001d150cf9f5453c135efe793e4ab19f94eca86175544e28a5078f19 -->
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
---
subcategory: ""
layout: "aws"
page_title: "Using Terraform Cloud's Continuous Validation feature with the AWS Provider"
page_title: "Using HCP Terraform's Continuous Validation feature with the AWS Provider"
description: |-
Using Terraform Cloud's Continuous Validation feature with the AWS Provider
Using HCP Terraform's Continuous Validation feature with the AWS Provider
---


<!-- Please do not edit this file, it is generated. -->
# Using Terraform Cloud's Continuous Validation feature with the AWS Provider
# Using HCP Terraform's Continuous Validation feature with the AWS Provider

## Continuous Validation in Terraform Cloud
## Continuous Validation in HCP Terraform

The Continuous Validation feature in Terraform Cloud (TFC) allows users to make assertions about their infrastructure between applied runs. This helps users to identify issues at the time they first appear and avoid situations where a change is only identified once it causes a customer-facing problem.
The Continuous Validation feature in HCP Terraform allows users to make assertions about their infrastructure between applied runs. This helps users to identify issues at the time they first appear and avoid situations where a change is only identified once it causes a customer-facing problem.

Users can add checks to their Terraform configuration using check blocks. Check blocks contain assertions that are defined with a custom condition expression and an error message. When the condition expression evaluates to true the check passes, but when the expression evaluates to false Terraform will show a warning message that includes the user-defined error message.

Expand Down Expand Up @@ -49,12 +49,12 @@ If the budget exceeds the set limit, the check block assertion will return a war

```
│ Warning: Check block assertion failed
│ on main.tf line 43, in check "check_budget_exceeded":
│ 43: condition = !data.aws_budgets_budget.example.budget_exceeded
│ ├────────────────
│ │ data.aws_budgets_budget.example.budget_exceeded is true
│ AWS budget has been exceeded! Calculated spend: '1550.0' and budget limit: '1200.0'
```

Expand Down Expand Up @@ -137,4 +137,4 @@ class MyConvertedCode(TerraformStack):
super().__init__(scope, name)
```

<!-- cache-key: cdktf-0.20.1 input-c0ad5f24294c75a13cad355527a321fe2fdea14c4cc2fe9df0aa6acdaee48195 -->
<!-- cache-key: cdktf-0.20.1 input-cc5813d66598277e8748e99325440be7aa6f97659fa8a60f715790f6f2a17af2 -->
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,7 @@ class MyConvertedCode(TerraformStack):
<li><code>bedrockagent</code></li>
<li><code>budgets</code></li>
<li><code>ce</code> (or <code>costexplorer</code>)</li>
<li><code>chatbot</code></li>
<li><code>chime</code></li>
<li><code>chimesdkmediapipelines</code></li>
<li><code>chimesdkvoice</code></li>
Expand Down Expand Up @@ -277,6 +278,7 @@ class MyConvertedCode(TerraformStack):
<li><code>rolesanywhere</code></li>
<li><code>route53</code></li>
<li><code>route53domains</code></li>
<li><code>route53profiles</code></li>
<li><code>route53recoverycontrolconfig</code></li>
<li><code>route53recoveryreadiness</code></li>
<li><code>route53resolver</code></li>
Expand Down Expand Up @@ -424,4 +426,4 @@ class MyConvertedCode(TerraformStack):
)
```

<!-- cache-key: cdktf-0.20.1 input-d65f1f0b651e175fa2bfe7882a2a41b16b6ea0a04040101331fe126be0abcbfe -->
<!-- cache-key: cdktf-0.20.1 input-fef19d282bd4baa2e4cfb819984b4f91b03ff5f8965b46d3753f80c46c4f1287 -->
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 1358 resources and 556 data sources available in the provider.
Use the navigation to the left to read about the available resources. There are currently 1359 resources and 556 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 @@ -804,4 +804,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.1 input-c61e162cf6a572515bdde3b148a587976e596534cd7fec90bbc109c10f91ff3d -->
<!-- cache-key: cdktf-0.20.1 input-60e66beedb59b39e668f28a996004cec04026d804b6e3d002ed29a779f05d6f9 -->
15 changes: 5 additions & 10 deletions website/docs/cdktf/python/r/appmesh_mesh.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -63,17 +63,12 @@ This resource supports the following arguments:

* `name` - (Required) Name to use for the service mesh. Must be between 1 and 255 characters in length.
* `spec` - (Optional) Service mesh specification to apply.
* `egress_filter`- (Optional) Egress filter rules for the service mesh.
* `type` - (Optional) Egress filter type. By default, the type is `DROP_ALL`. Valid values are `ALLOW_ALL` and `DROP_ALL`.
* `service_discovery`- (Optional) The service discovery information for the service mesh.
* `ip_preference` - (Optional) The IP version to use to control traffic within the mesh. Valid values are `IPv6_PREFERRED`, `IPv4_PREFERRED`, `IPv4_ONLY`, and `IPv6_ONLY`.
* `tags` - (Optional) Map of tags to assign to the resource. If configured with a provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level.

The `spec` object supports the following:

* `egress_filter`- (Optional) Egress filter rules for the service mesh.

The `egress_filter` object supports the following:

* `type` - (Optional) Egress filter type. By default, the type is `DROP_ALL`.
Valid values are `ALLOW_ALL` and `DROP_ALL`.

## Attribute Reference

This resource exports the following attributes in addition to the arguments above:
Expand Down Expand Up @@ -111,4 +106,4 @@ Using `terraform import`, import App Mesh service meshes using the `name`. For e
% terraform import aws_appmesh_mesh.simple simpleapp
```

<!-- cache-key: cdktf-0.20.1 input-3173e5025bf46613bb3d81fd897c112506cd0123d7fe3d3c9ffea66ee2187a85 -->
<!-- cache-key: cdktf-0.20.1 input-6fabf3d074187453279c89dc4a5acf10ecf8a373b0e45a5236e4039a7bfc702f -->
20 changes: 13 additions & 7 deletions website/docs/cdktf/python/r/auditmanager_framework.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Terraform resource for managing an AWS Audit Manager Framework.
```python
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
from constructs import Construct
from cdktf import Token, TerraformStack
from cdktf import TerraformStack
#
# Provider bindings are generated by running `cdktf get`.
# See https://cdk.tf/provider-generation for more details.
Expand All @@ -31,7 +31,9 @@ class MyConvertedCode(TerraformStack):
AuditmanagerFramework(self, "test",
control_sets=[AuditmanagerFrameworkControlSets(
controls=[AuditmanagerFrameworkControlSetsControls(
id=Token.as_string(aws_auditmanager_control_test.id)
id=test1.id
), AuditmanagerFrameworkControlSetsControls(
id=test2.id
)
],
name="example"
Expand All @@ -46,20 +48,24 @@ class MyConvertedCode(TerraformStack):
The following arguments are required:

* `name` - (Required) Name of the framework.
* `control_sets` - (Required) Control sets that are associated with the framework. See [`control_sets`](#control_sets) below.
* `control_sets` - (Required) Configuration block(s) for the control sets that are associated with the framework. See [`control_sets` Block](#control_sets-block) below for details.

The following arguments are optional:

* `compliance_type` - (Optional) Compliance type that the new custom framework supports, such as `CIS` or `HIPAA`.
* `description` - (Optional) Description of the framework.
* `tags` - (Optional) A map of tags to assign to the framework. If configured with a provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level.

### control_sets
### `control_sets` Block

The `control_sets` configuration block supports the following arguments:

* `name` - (Required) Name of the control set.
* `controls` - (Required) List of controls within the control set. See [`controls`](#controls) below.
* `controls` - (Required) Configuration block(s) for the controls within the control set. See [`controls` Block](#controls-block) below for details.

### `controls` Block

### controls
The `controls` configuration block supports the following arguments:

* `id` - (Required) Unique identifier of the control.

Expand Down Expand Up @@ -97,4 +103,4 @@ Using `terraform import`, import Audit Manager Framework using the framework `id
% terraform import aws_auditmanager_framework.example abc123-de45
```

<!-- cache-key: cdktf-0.20.1 input-821a948286ad3665c063ce96f7b07cc9d38f2a8d5044bfae6a4c6b6094687367 -->
<!-- cache-key: cdktf-0.20.1 input-93d510f54f0d893a89ff49786d9c2af44b17e105211d90aef366d90b4e1975a5 -->
13 changes: 5 additions & 8 deletions website/docs/cdktf/python/r/batch_job_definition.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -224,17 +224,14 @@ The following arguments are required:

The following arguments are optional:

* `container_properties` - (Optional) A valid [container properties](http://docs.aws.amazon.com/batch/latest/APIReference/API_RegisterJobDefinition.html)
provided as a single valid JSON document. This parameter is only valid if the `type` parameter is `container`.
* `container_properties` - (Optional) A valid [container properties](http://docs.aws.amazon.com/batch/latest/APIReference/API_RegisterJobDefinition.html) provided as a single valid JSON document. This parameter is only valid if the `type` parameter is `container`.
* `deregister_on_new_revision` - (Optional) When updating a job definition a new revision is created. This parameter determines if the previous version is `deregistered` (`INACTIVE`) or left `ACTIVE`. Defaults to `true`.
* `node_properties` - (Optional) A valid [node properties](http://docs.aws.amazon.com/batch/latest/APIReference/API_RegisterJobDefinition.html)
provided as a single valid JSON document. This parameter is required if the `type` parameter is `multinode`.
* `node_properties` - (Optional) A valid [node properties](http://docs.aws.amazon.com/batch/latest/APIReference/API_RegisterJobDefinition.html) provided as a single valid JSON document. This parameter is required if the `type` parameter is `multinode`.
* `eks_properties` - (Optional) A valid [eks properties](#eks_properties). This parameter is only valid if the `type` parameter is `container`.
* `parameters` - (Optional) Specifies the parameter substitution placeholders to set in the job definition.
* `platform_capabilities` - (Optional) The platform capabilities required by the job definition. If no value is specified, it defaults to `EC2`. To run the job on Fargate resources, specify `FARGATE`.
* `propagate_tags` - (Optional) Specifies whether to propagate the tags from the job definition to the corresponding Amazon ECS task. Default is `false`.
* `retry_strategy` - (Optional) Specifies the retry strategy to use for failed jobs that are submitted with this job definition.
Maximum number of `retry_strategy` is `1`. Defined below.
* `retry_strategy` - (Optional) Specifies the retry strategy to use for failed jobs that are submitted with this job definition. Maximum number of `retry_strategy` is `1`. Defined below.
* `scheduling_priority` - (Optional) The scheduling priority of the job definition. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority. Allowed values `0` through `9999`.
* `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level.
* `timeout` - (Optional) Specifies the timeout for jobs so that if a job runs longer, AWS Batch terminates the job. Maximum number of `timeout` is `1`. Defined below.
Expand Down Expand Up @@ -290,7 +287,7 @@ The following arguments are optional:

#### `evaluate_on_exit`

* `action` - (Required) Specifies the action to take if all of the specified conditions are met. The values are not case sensitive. Valid values: `RETRY`, `EXIT`.
* `action` - (Required) Specifies the action to take if all of the specified conditions are met. The values are not case sensitive. Valid values: `retry`, `exit`.
* `on_exit_code` - (Optional) A glob pattern to match against the decimal representation of the exit code returned for a job.
* `on_reason` - (Optional) A glob pattern to match against the reason returned for a job.
* `on_status_reason` - (Optional) A glob pattern to match against the status reason returned for a job.
Expand Down Expand Up @@ -333,4 +330,4 @@ Using `terraform import`, import Batch Job Definition using the `arn`. For examp
% terraform import aws_batch_job_definition.test arn:aws:batch:us-east-1:123456789012:job-definition/sample
```

<!-- cache-key: cdktf-0.20.1 input-bd9147ef7f6fa35db163f0270a06f4b1163f2e6f23072ece378070600f017a0e -->
<!-- cache-key: cdktf-0.20.1 input-a601dba3c095da075f0b1e61565a10ccc796a5a15ab0385930fcb09cf34abb8c -->