Skip to content

Commit 7fa8fac

Browse files
ewbankkitewbankkit
authored
Merge pull request #44474 from hashicorp/d-cdktf-docs-18081830670-169
cdktf: update documentation
2 parents e0e2e15 + 907013e commit 7fa8fac

File tree

54 files changed

+1969
-78
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+1969
-78
lines changed

‎website/docs/cdktf/python/actions/codebuild_start_build.html.markdown‎

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
---
2+
subcategory: "CodeBuild"
3+
layout: "aws"
4+
page_title: "AWS: aws_codebuild_start_build"
5+
description: |-
6+
Starts a CodeBuild project build.
7+
---
8+
9+
10+
<!-- Please do not edit this file, it is generated. -->
11+
# Action: aws_codebuild_start_build
12+
13+
~> **Note:** `aws_codebuild_start_build` is in beta. Its interface and behavior may change as the feature evolves, and breaking changes are possible. It is offered as a technical preview without compatibility guarantees until Terraform 1.14 is generally available.
14+
15+
Starts a CodeBuild project build. This action will initiate a build and wait for it to complete, providing progress updates during execution.
16+
17+
For information about AWS CodeBuild, see the [AWS CodeBuild User Guide](https://docs.aws.amazon.com/codebuild/latest/userguide/). For specific information about starting builds, see the [StartBuild](https://docs.aws.amazon.com/codebuild/latest/APIReference/API_StartBuild.html) page in the AWS CodeBuild API Reference.
18+
19+
## Example Usage
20+
21+
### Basic Usage
22+
23+
```python
24+
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
25+
from cdktf import TerraformResourceLifecycle
26+
from constructs import Construct
27+
from cdktf import Token, DataResource, TerraformStack
28+
#
29+
# Provider bindings are generated by running `cdktf get`.
30+
# See https://cdk.tf/provider-generation for more details.
31+
#
32+
from imports.aws.codebuild_project import CodebuildProject
33+
class MyConvertedCode(TerraformStack):
34+
def __init__(self, scope, name):
35+
super().__init__(scope, name)
36+
CodebuildProject(self, "example",
37+
artifacts=CodebuildProjectArtifacts(
38+
type="NO_ARTIFACTS"
39+
),
40+
environment=CodebuildProjectEnvironment(
41+
compute_type="BUILD_GENERAL1_SMALL",
42+
image="aws/codebuild/amazonlinux2-x86_64-standard:3.0",
43+
type="LINUX_CONTAINER"
44+
),
45+
name="example-project",
46+
service_role=Token.as_string(aws_iam_role_example.arn),
47+
source=CodebuildProjectSource(
48+
buildspec="version: 0.2\nphases:\n build:\n commands:\n - echo 'Hello World'\n",
49+
type="NO_SOURCE"
50+
)
51+
)
52+
DataResource(self, "build_trigger",
53+
input="trigger-build",
54+
lifecycle=TerraformResourceLifecycle(
55+
action_trigger=[{
56+
"actions": [aws_codebuild_start_build.example],
57+
"events": [after_create]
58+
}
59+
]
60+
)
61+
)
62+
```
63+
64+
### Build with Environment Variables
65+
66+
```python
67+
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
68+
from constructs import Construct
69+
from cdktf import TerraformStack
70+
class MyConvertedCode(TerraformStack):
71+
def __init__(self, scope, name):
72+
super().__init__(scope, name)
73+
```
74+
75+
## Argument Reference
76+
77+
The following arguments are required:
78+
79+
* `project_name` - (Required) Name of the CodeBuild project to build.
80+
81+
The following arguments are optional:
82+
83+
* `source_version` - (Optional) Version of the build input to be built. For GitHub, this can be a commit SHA, branch name, or tag name.
84+
* `timeout` - (Optional) Timeout in seconds for the build operation. Defaults to 1800 seconds (30 minutes).
85+
* `environment_variables_override` - (Optional) Environment variables to override for this build. See [Environment Variables Override](#environment-variables-override) below.
86+
87+
### Environment Variables Override
88+
89+
* `name` - (Required) Environment variable name.
90+
* `value` - (Required) Environment variable value.
91+
* `type` - (Optional) Environment variable type. Valid values are `PLAINTEXT`, `PARAMETER_STORE`, or `SECRETS_MANAGER`. Defaults to `PLAINTEXT`.
92+
93+
<!-- cache-key: cdktf-0.20.8 input-2e2b95c74f53bc3ba04dd81a3e762f7d1a0e989b36d5054777ae50d5aec3b8b9 -->

‎website/docs/cdktf/python/actions/sfn_start_execution.html.markdown‎

Lines changed: 187 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,187 @@
1+
---
2+
subcategory: "SFN (Step Functions)"
3+
layout: "aws"
4+
page_title: "AWS: aws_sfn_start_execution"
5+
description: |-
6+
Starts a Step Functions state machine execution with the specified input data.
7+
---
8+
9+
10+
<!-- Please do not edit this file, it is generated. -->
11+
# Action: aws_sfn_start_execution
12+
13+
~> **Note:** `aws_sfn_start_execution` is in beta. Its interface and behavior may change as the feature evolves, and breaking changes are possible. It is offered as a technical preview without compatibility guarantees until Terraform 1.14 is generally available.
14+
15+
Starts a Step Functions state machine execution with the specified input data. This action allows for imperative execution of state machines with full control over execution parameters.
16+
17+
For information about AWS Step Functions, see the [AWS Step Functions Developer Guide](https://docs.aws.amazon.com/step-functions/latest/dg/). For specific information about starting executions, see the [StartExecution](https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartExecution.html) page in the AWS Step Functions API Reference.
18+
19+
~> **Note:** For `STANDARD` workflows, executions with the same name and input are idempotent. For `EXPRESS` workflows, each execution is unique regardless of name and input.
20+
21+
## Example Usage
22+
23+
### Basic Usage
24+
25+
```python
26+
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
27+
from cdktf import TerraformResourceLifecycle
28+
from constructs import Construct
29+
from cdktf import Fn, Token, DataResource, TerraformStack
30+
#
31+
# Provider bindings are generated by running `cdktf get`.
32+
# See https://cdk.tf/provider-generation for more details.
33+
#
34+
from imports.aws.sfn_state_machine import SfnStateMachine
35+
class MyConvertedCode(TerraformStack):
36+
def __init__(self, scope, name):
37+
super().__init__(scope, name)
38+
SfnStateMachine(self, "example",
39+
definition=Token.as_string(
40+
Fn.jsonencode({
41+
"Comment": "A simple minimal example",
42+
"StartAt": "Hello",
43+
"States": {
44+
"Hello": {
45+
"End": True,
46+
"Result": "Hello World!",
47+
"Type": "Pass"
48+
}
49+
}
50+
})),
51+
name="example-state-machine",
52+
role_arn=sfn.arn
53+
)
54+
terraform_data_example = DataResource(self, "example_1",
55+
input="trigger-execution",
56+
lifecycle=TerraformResourceLifecycle(
57+
action_trigger=[{
58+
"actions": [aws_sfn_start_execution.example],
59+
"events": [before_create, before_update]
60+
}
61+
]
62+
)
63+
)
64+
# This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.
65+
terraform_data_example.override_logical_id("example")
66+
```
67+
68+
### Named Execution
69+
70+
```python
71+
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
72+
from constructs import Construct
73+
from cdktf import TerraformStack
74+
class MyConvertedCode(TerraformStack):
75+
def __init__(self, scope, name):
76+
super().__init__(scope, name)
77+
```
78+
79+
### Execution with Version
80+
81+
```python
82+
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
83+
from constructs import Construct
84+
from cdktf import TerraformStack
85+
class MyConvertedCode(TerraformStack):
86+
def __init__(self, scope, name):
87+
super().__init__(scope, name)
88+
```
89+
90+
### Execution with Alias
91+
92+
```python
93+
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
94+
from constructs import Construct
95+
from cdktf import TerraformStack
96+
#
97+
# Provider bindings are generated by running `cdktf get`.
98+
# See https://cdk.tf/provider-generation for more details.
99+
#
100+
from imports.aws.sfn_alias import SfnAlias
101+
class MyConvertedCode(TerraformStack):
102+
def __init__(self, scope, name, *, stateMachineVersionArn, weight):
103+
super().__init__(scope, name)
104+
SfnAlias(self, "prod",
105+
name="PROD",
106+
routing_configuration=[SfnAliasRoutingConfiguration(
107+
state_machine_version_weight=[{
108+
"state_machine_version_arn": example.arn,
109+
"weight": 100
110+
}
111+
],
112+
state_machine_version_arn=state_machine_version_arn,
113+
weight=weight
114+
)
115+
],
116+
state_machine_arn=example.arn
117+
)
118+
```
119+
120+
### X-Ray Tracing
121+
122+
```python
123+
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
124+
from constructs import Construct
125+
from cdktf import TerraformStack
126+
class MyConvertedCode(TerraformStack):
127+
def __init__(self, scope, name):
128+
super().__init__(scope, name)
129+
```
130+
131+
### CI/CD Pipeline Integration
132+
133+
Use this action in your deployment pipeline to trigger post-deployment workflows:
134+
135+
```python
136+
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
137+
from cdktf import TerraformResourceLifecycle
138+
from constructs import Construct
139+
from cdktf import DataResource, TerraformStack
140+
class MyConvertedCode(TerraformStack):
141+
def __init__(self, scope, name):
142+
super().__init__(scope, name)
143+
DataResource(self, "deploy_complete",
144+
depends_on=[processors],
145+
input=deployment_id,
146+
lifecycle=TerraformResourceLifecycle(
147+
action_trigger=[{
148+
"actions": [aws_sfn_start_execution.post_deploy],
149+
"events": [before_create, before_update]
150+
}
151+
]
152+
)
153+
)
154+
```
155+
156+
### Environment-Specific Processing
157+
158+
```python
159+
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
160+
from constructs import Construct
161+
from cdktf import TerraformStack
162+
class MyConvertedCode(TerraformStack):
163+
def __init__(self, scope, name):
164+
super().__init__(scope, name)
165+
```
166+
167+
### Complex Workflow Orchestration
168+
169+
```python
170+
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
171+
from constructs import Construct
172+
from cdktf import TerraformStack
173+
class MyConvertedCode(TerraformStack):
174+
def __init__(self, scope, name):
175+
super().__init__(scope, name)
176+
```
177+
178+
## Argument Reference
179+
180+
This action supports the following arguments:
181+
182+
* `input` - (Optional) JSON input data for the execution. Must be valid JSON. Defaults to `{}` if not specified. The input size limit is 256 KB.
183+
* `name` - (Optional) Name of the execution. Must be unique within the account/region/state machine for 90 days. If not provided, Step Functions automatically generates a UUID. Names must not contain whitespace, brackets, wildcards, or special characters.
184+
* `state_machine_arn` - (Required) ARN of the state machine to execute. Can be an unqualified ARN, version-qualified ARN (e.g., `arn:aws:states:region:account:stateMachine:name:version`), or alias-qualified ARN (e.g., `arn:aws:states:region:account:stateMachine:name:alias`).
185+
* `trace_header` - (Optional) AWS X-Ray trace header for distributed tracing. Used to correlate execution traces across services.
186+
187+
<!-- cache-key: cdktf-0.20.8 input-f50fb55ee205b83bb20f487d54e45117cd2994b0cffa9684ab55b6deaddea547 -->

‎website/docs/cdktf/python/d/appconfig_application.html.markdown‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
subcategory: "AppConfig"
3+
layout: "aws"
4+
page_title: "AWS: aws_appconfig_application"
5+
description: |-
6+
Retrieves an AWS AppConfig Application by name.
7+
---
8+
9+
10+
<!-- Please do not edit this file, it is generated. -->
11+
# Data Source: aws_appconfig_application
12+
13+
Provides details about an AWS AppConfig Application.
14+
15+
## Example Usage
16+
17+
### Basic Usage
18+
19+
```python
20+
# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug
21+
from constructs import Construct
22+
from cdktf import TerraformStack
23+
#
24+
# Provider bindings are generated by running `cdktf get`.
25+
# See https://cdk.tf/provider-generation for more details.
26+
#
27+
from imports.aws. import DataAwsAppconfigApplication
28+
class MyConvertedCode(TerraformStack):
29+
def __init__(self, scope, name):
30+
super().__init__(scope, name)
31+
DataAwsAppconfigApplication(self, "example",
32+
name="my-appconfig-application"
33+
)
34+
```
35+
36+
## Argument Reference
37+
38+
This data source supports the following arguments:
39+
40+
* `region` - (Optional) Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the [provider configuration](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#aws-configuration-reference).
41+
* `id` - (Optional) ID of the Application. Either `id` or `name` must be specified.
42+
* `name` - (Optional) AWS AppConfig Application name. Either `name` or `id` must be specified.
43+
44+
## Attribute Reference
45+
46+
This data source exports the following attributes in addition to the arguments above:
47+
48+
* `arn` - ARN of the Application.
49+
* `description` - Description of the Application.
50+
51+
<!-- cache-key: cdktf-0.20.8 input-cf91abf79b224531aadcc5a8cbb5a7f7d15f2002e52309c222a2837b487636a2 -->

‎website/docs/cdktf/python/d/db_proxy.html.markdown‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ This data source exports the following attributes in addition to the arguments a
4545
* `arn` - ARN of the DB Proxy.
4646
* `auth` - Configuration(s) with authorization mechanisms to connect to the associated instance or cluster.
4747
* `debug_logging` - Whether the proxy includes detailed information about SQL statements in its logs.
48+
* `default_auth_scheme` - Default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database.
4849
* `endpoint` - Endpoint that you can use to connect to the DB proxy.
4950
* `engine_family` - Kinds of databases that the proxy can connect to.
5051
* `idle_client_timeout` - Number of seconds a connection to the proxy can have no activity before the proxy drops the client connection.
@@ -54,4 +55,4 @@ This data source exports the following attributes in addition to the arguments a
5455
* `vpc_security_group_ids` - Provides a list of VPC security groups that the proxy belongs to.
5556
* `vpc_subnet_ids` - EC2 subnet IDs for the proxy.
5657

57-
<!-- cache-key: cdktf-0.20.8 input-07965549e5f838c09acb0a5b32b2f375c5ad322b528252715661d2835efc1585 -->
58+
<!-- cache-key: cdktf-0.20.8 input-2d7107af0b40b25e985e6a5808abdb4493f3c83631c51bca95c34e0824918c71 -->

‎website/docs/cdktf/python/d/ec2_instance_type_offering.html.markdown‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,11 +56,12 @@ This data source exports the following attributes in addition to the arguments a
5656

5757
* `id` - EC2 Instance Type.
5858
* `instance_type` - EC2 Instance Type.
59+
* `location` - Identifier for the location.
5960

6061
## Timeouts
6162

6263
[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts):
6364

6465
- `read` - (Default `20m`)
6566

66-
<!-- cache-key: cdktf-0.20.8 input-cea329a574bb9d637aa260a1a03d720bdeac1729112175af91aefd0a746fd785 -->
67+
<!-- cache-key: cdktf-0.20.8 input-54954ccf1496d4080728535126f8b2ceaf72dff5f9092223992efd7a36d6a8c9 -->

0 commit comments

Comments
 (0)