Skip to content

Commit

Permalink
Merge pull request #39338 from hashicorp/d-cdktf-docs-10875444146-108
Browse files Browse the repository at this point in the history
cdktf: update documentation
  • Loading branch information
ewbankkit committed Sep 16, 2024
2 parents 46ed0b5 + d53cf03 commit b4a7860
Show file tree
Hide file tree
Showing 54 changed files with 2,821 additions and 308 deletions.
109 changes: 109 additions & 0 deletions website/docs/cdktf/python/d/codebuild_fleet.html.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
---
subcategory: "CodeBuild"
layout: "aws"
page_title: "AWS: aws_codebuild_fleet"
description: |-
Retrieve information about an CodeBuild Fleet
---


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

Retrieve information about an CodeBuild Fleet.

## 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.codebuild_fleet import CodebuildFleet
from imports.aws.data_aws_codebuild_fleet import DataAwsCodebuildFleet
class MyConvertedCode(TerraformStack):
def __init__(self, scope, name):
super().__init__(scope, name)
test = CodebuildFleet(self, "test",
base_capacity=2,
compute_type="BUILD_GENERAL1_SMALL",
environment_type="LINUX_CONTAINER",
name="full-example-codebuild-fleet",
overflow_behavior="QUEUE",
scaling_configuration=CodebuildFleetScalingConfiguration(
max_capacity=5,
scaling_type="TARGET_TRACKING_SCALING",
target_tracking_scaling_configs=[CodebuildFleetScalingConfigurationTargetTrackingScalingConfigs(
metric_type="FLEET_UTILIZATION_RATE",
target_value=97.5
)
]
)
)
data_aws_codebuild_fleet_test = DataAwsCodebuildFleet(self, "test_1",
name=test.name
)
# 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_codebuild_fleet_test.override_logical_id("test")
```

### 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_codebuild_fleet import DataAwsCodebuildFleet
class MyConvertedCode(TerraformStack):
def __init__(self, scope, name):
super().__init__(scope, name)
DataAwsCodebuildFleet(self, "example",
name="my-codebuild-fleet-name"
)
```

## Argument Reference

The following arguments are required:

* `name` - (Required) Fleet name.

## Attribute Reference

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

* `arn` - ARN of the Fleet.
* `base_capacity` - Number of machines allocated to the fleet.
* `compute_type` - Compute resources the compute fleet uses.
* `created` - Creation time of the fleet.
* `environment_type` - Environment type of the compute fleet.
* `fleet_service_role` - The service role associated with the compute fleet.
* `id` - ARN of the Fleet.
* `image_id` - The Amazon Machine Image (AMI) of the compute fleet.
* `last_modified` - Last modification time of the fleet.
* `overflow_behavior` - Overflow behavior for compute fleet.
* `scaling_configuration` - Nested attribute containing information about the scaling configuration.
* `desired_capacity` - The desired number of instances in the fleet when auto-scaling.
* `max_capacity` - The maximum number of instances in the fleet when auto-scaling.
* `scaling_type` - The scaling type for a compute fleet.
* `target_tracking_scaling_configs` - Nested attribute containing information about thresholds when new instance is auto-scaled into the compute fleet.
* `metric_type` - The metric type to determine auto-scaling.
* `target_value` - The value of metric_type when to start scaling.
* `status` - Nested attribute containing information about the current status of the fleet.
* `context` - Additional information about a compute fleet.
* `message` - Message associated with the status of a compute fleet.
* `status_code` - Status code of the compute fleet.
* `tags` - Mapping of Key-Value tags for the resource.
* `vpc_config` - Nested attribute containing information about the VPC configuration.
* `security_group_ids` - A list of one or more security groups IDs in your Amazon VPC.
* `subnets` - A list of one or more subnet IDs in your Amazon VPC.
* `vpc_id` - The ID of the Amazon VPC.

<!-- cache-key: cdktf-0.20.1 input-1dd0c64b00818aba259878581a28993546ff6920dd1e6d4faaf8fd87b76f41ae -->
7 changes: 4 additions & 3 deletions website/docs/cdktf/python/d/cognito_user_pool.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ from cdktf import TerraformStack
# Provider bindings are generated by running `cdktf get`.
# See https://cdk.tf/provider-generation for more details.
#
from imports.aws. import DataAwsCognitoUserPool
from imports.aws.data_aws_cognito_user_pool import DataAwsCognitoUserPool
class MyConvertedCode(TerraformStack):
def __init__(self, scope, name):
super().__init__(scope, name)
Expand Down Expand Up @@ -62,7 +62,8 @@ This data source exports the following attributes in addition to the arguments a
* `sms_authentication_message` - The contents of the SMS authentication message.
* `sms_configuration_failure` - The reason why the SMS configuration can't send the messages to your users.
* `sms_verification_message` - The contents of the SMS authentication message.
* `user_pool_tags` - The tags that are assigned to the user pool. A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
* `tags` - Map of tags assigned to the resource.
* `user_pool_tags` - (Deprecated) Map of tags assigned to the resource.
* `username_attributes` - Specifies whether a user can use an email address or phone number as a username when they sign up.

### account recover setting
Expand Down Expand Up @@ -130,4 +131,4 @@ This data source exports the following attributes in addition to the arguments a
* `max_length` - Maximum allowed length.
* `min_length` - Minimum allowed length.

<!-- cache-key: cdktf-0.20.1 input-6414f93a1d42555285aa8bfd3568720a717746ce22c45c58bb57438d1f2fa18f -->
<!-- cache-key: cdktf-0.20.1 input-248870b64287dfd8eb6270d8115ae3300366c000a76f505a411906be62417cdc -->
12 changes: 7 additions & 5 deletions website/docs/cdktf/python/d/kinesis_stream.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -44,13 +44,15 @@ class MyConvertedCode(TerraformStack):
are exported:

* `arn` - ARN of the Kinesis Stream (same as id).
* `name` - Name of the Kinesis Stream.
* `closed_shards` - List of shard ids in the CLOSED state. See [Shard State][2] for more.
* `creation_timestamp` - Approximate UNIX timestamp that the stream was created.
* `status` - Current status of the stream. The stream status is one of CREATING, DELETING, ACTIVE, or UPDATING.
* `retention_period` - Length of time (in hours) data records are accessible after they are added to the stream.
* `encryption_type` - Encryption type used.
* `kms_key_id` - GUID for the customer-managed AWS KMS key to use for encryption.
* `name` - Name of the Kinesis Stream.
* `open_shards` - List of shard ids in the OPEN state. See [Shard State][2] for more.
* `closed_shards` - List of shard ids in the CLOSED state. See [Shard State][2] for more.
* `retention_period` - Length of time (in hours) data records are accessible after they are added to the stream.
* `shard_level_metrics` - List of shard-level CloudWatch metrics which are enabled for the stream. See [Monitoring with CloudWatch][3] for more.
* `status` - Current status of the stream. The stream status is one of CREATING, DELETING, ACTIVE, or UPDATING.
* `stream_mode_details` - [Capacity mode][4] of the data stream. Detailed below.
* `tags` - Map of tags to assigned to the stream.

Expand All @@ -63,4 +65,4 @@ are exported:
[3]: https://docs.aws.amazon.com/streams/latest/dev/monitoring-with-cloudwatch.html
[4]: https://docs.aws.amazon.com/streams/latest/dev/how-do-i-size-a-stream.html

<!-- cache-key: cdktf-0.20.1 input-d035d44fea77906534614187920d80dfcb1210dd3b168e9a8322ca2eeaffb5f5 -->
<!-- cache-key: cdktf-0.20.1 input-fa9e8af044240db88bc0177862ab514d3d3abe026c71cbc8ce4c90ad35bdc2bd -->
37 changes: 33 additions & 4 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 1409 resources and 575 data sources available in the provider.
Use the navigation to the left to read about the available resources. There are currently 1410 resources and 578 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 @@ -87,6 +87,7 @@ and the [AWS SDKs](https://aws.amazon.com/tools/).
The AWS Provider supports assuming an IAM role, either in
the provider configuration block parameter `assume_role`
or in [a named profile](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-role.html).
If configuring the role in the provider configuration, the provider supports IAM Role Chaining by specifying a list of roles to assume.

The AWS Provider supports assuming an IAM role using [web identity federation and OpenID Connect (OIDC)](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-role.html#cli-configure-role-oidc).
This can be configured either using environment variables or in a named profile.
Expand Down Expand Up @@ -240,6 +241,30 @@ class MyConvertedCode(TerraformStack):
)
```

To assume a role with role chaining, do the following:

```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.provider import AwsProvider
class MyConvertedCode(TerraformStack):
def __init__(self, scope, name):
super().__init__(scope, name)
AwsProvider(self, "aws",
assume_role=[AwsProviderAssumeRole(
role_arn="arn:aws:iam::123456789012:role/INITIAL_ROLE_NAME"
), AwsProviderAssumeRole(
role_arn="arn:aws:iam::123456789012:role/FINAL_ROLE_NAME"
)
]
)
```

> **Hands-on:** Try the [Use AssumeRole to Provision AWS Resources Across Accounts](https://learn.hashicorp.com/tutorials/terraform/aws-assumerole) tutorial.
### Assuming an IAM Role Using A Web Identity
Expand Down Expand Up @@ -382,7 +407,9 @@ In addition to [generic `provider` arguments](https://www.terraform.io/docs/conf

* `access_key` - (Optional) AWS access key. Can also be set with the `AWS_ACCESS_KEY_ID` environment variable, or via a shared credentials file if `profile` is specified. See also `secret_key`.
* `allowed_account_ids` - (Optional) List of allowed AWS account IDs to prevent you from mistakenly using an incorrect one (and potentially end up destroying a live environment). Conflicts with `forbidden_account_ids`.
* `assume_role` - (Optional) Configuration block for assuming an IAM role. See the [`assume_role` Configuration Block](#assume_role-configuration-block) section below. Only one `assume_role` block may be in the configuration.
* `assume_role` - (Optional) List of configuration blocks for assuming an IAM role.
See the [`assume_role` Configuration Block](#assume_role-configuration-block) section below.
IAM Role Chaining is supported by specifying the roles to assume in order.
* `assume_role_with_web_identity` - (Optional) Configuration block for assuming an IAM role using a web identity. See the [`assume_role_with_web_identity` Configuration Block](#assume_role_with_web_identity-configuration-block) section below. Only one `assume_role_with_web_identity` block may be in the configuration.
* `custom_ca_bundle` - (Optional) File containing custom root and intermediate certificates.
Can also be set using the `AWS_CA_BUNDLE` environment variable.
Expand Down Expand Up @@ -569,7 +596,9 @@ In addition to [generic `provider` arguments](https://www.terraform.io/docs/conf

The `assume_role` configuration block supports the following arguments:

* `duration` - (Optional) Duration of the assume role session. You can provide a value from 15 minutes up to the maximum session duration setting for the role. Represented by a string such as `1h`, `2h45m`, or `30m15s`.
* `duration` - (Optional) Duration of the assume role session.
You can provide a value from 15 minutes up to the maximum session duration setting for the role.
Represented by a string such as `1h`, `2h45m`, or `30m15s`.
* `external_id` - (Optional) External identifier to use when assuming the role.
* `policy` - (Optional) IAM Policy JSON describing further restricting permissions for the IAM Role being assumed.
* `policy_arns` - (Optional) Set of Amazon Resource Names (ARNs) of IAM Policies describing further restricting permissions for the IAM Role being assumed.
Expand Down Expand Up @@ -869,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.1 input-f7ae442304a7d2279c2fd243c7e8d42368ce7960d737aa15865972bcc37afb95 -->
<!-- cache-key: cdktf-0.20.1 input-f8c0cbb53f12013d6615da7f40765529f796575a78bc1ccb6b5242f14dded469 -->
21 changes: 16 additions & 5 deletions website/docs/cdktf/python/r/amplify_app.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -187,12 +187,13 @@ This resource supports the following arguments:

* `name` - (Required) Name for an Amplify app.
* `access_token` - (Optional) Personal access token for a third-party source control system for an Amplify app. This token must have write access to the relevant repo to create a webhook and a read-only deploy key for the Amplify project. The token is not stored, so after applying this attribute can be removed and the setup token deleted.
* `auto_branch_creation_config` - (Optional) Automated branch creation configuration for an Amplify app. An `auto_branch_creation_config` block is documented below.
* `auto_branch_creation_config` - (Optional) Automated branch creation configuration for an Amplify app. See [`auto_branch_creation_config` Block](#auto_branch_creation_config-block) for details.
* `auto_branch_creation_patterns` - (Optional) Automated branch creation glob patterns for an Amplify app.
* `basic_auth_credentials` - (Optional) Credentials for basic authorization for an Amplify app.
* `build_spec` - (Optional) The [build specification](https://docs.aws.amazon.com/amplify/latest/userguide/build-settings.html) (build spec) for an Amplify app.
* `cache_config` - (Optional) Cache configuration for the Amplify app. See [`cache_config` Block](#cache_config-block) for details.
* `custom_headers` - (Optional) The [custom HTTP headers](https://docs.aws.amazon.com/amplify/latest/userguide/custom-headers.html) for an Amplify app.
* `custom_rule` - (Optional) Custom rewrite and redirect rules for an Amplify app. A `custom_rule` block is documented below.
* `custom_rule` - (Optional) Custom rewrite and redirect rules for an Amplify app. See [`custom_rule` Block](#custom_rule-block) for details.
* `description` - (Optional) Description for an Amplify app.
* `enable_auto_branch_creation` - (Optional) Enables automated branch creation for an Amplify app.
* `enable_basic_auth` - (Optional) Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app.
Expand All @@ -205,7 +206,9 @@ This resource supports the following arguments:
* `repository` - (Optional) Repository for an Amplify app.
* `tags` - (Optional) Key-value mapping 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.

An `auto_branch_creation_config` block supports the following arguments:
### `auto_branch_creation_config` Block

The `auto_branch_creation_config` configuration block supports the following arguments:

* `basic_auth_credentials` - (Optional) Basic authorization credentials for the autocreated branch.
* `build_spec` - (Optional) Build specification (build spec) for the autocreated branch.
Expand All @@ -218,7 +221,15 @@ An `auto_branch_creation_config` block supports the following arguments:
* `pull_request_environment_name` - (Optional) Amplify environment name for the pull request.
* `stage` - (Optional) Describes the current stage for the autocreated branch. Valid values: `PRODUCTION`, `BETA`, `DEVELOPMENT`, `EXPERIMENTAL`, `PULL_REQUEST`.

A `custom_rule` block supports the following arguments:
### `cache_config` Block

The `cache_config` configuration block supports the following arguments:

- `type` - (Required) Type of cache configuration to use for an Amplify app. Valid values: `AMPLIFY_MANAGED`, `AMPLIFY_MANAGED_NO_COOKIES`.

### `custom_rule` Block

The `custom_rule` configuration block supports the following arguments:

* `condition` - (Optional) Condition for a URL rewrite or redirect rule, such as a country code.
* `source` - (Required) Source pattern for a URL rewrite or redirect rule.
Expand Down Expand Up @@ -269,4 +280,4 @@ Using `terraform import`, import Amplify App using Amplify App ID (appId). For e

App ID can be obtained from App ARN (e.g., `arn:aws:amplify:us-east-1:12345678:apps/d2ypk4k47z8u6`).

<!-- cache-key: cdktf-0.20.1 input-d7ee79d01f5e2f26ebf8925269494af0843648275257f3560646ceda6935e583 -->
<!-- cache-key: cdktf-0.20.1 input-c654202f4b2998abd6708efac5e85089c2fe4ff2ec3b84681ad72e031d2e94df -->
Loading

0 comments on commit b4a7860

Please sign in to comment.