Skip to content

cdktf: update documentation #42832

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

Merged
merged 1 commit into from
Jun 2, 2025
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions website/docs/cdktf/python/d/ami.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,8 @@ This data source exports the following attributes in addition to the arguments a
* `snapshot_id` - The ID of the snapshot.
* `volume_size` - The size of the volume, in GiB.
* `throughput` - The throughput that the EBS volume supports, in MiB/s.
* `volume_initialization_rate` - The volume initialization rate, in MiB/s.
* `volume_type` - The volume type.
* `volume_initialization_rate` - The volume initialization rate, in MiB/s.
* `no_device` - Suppresses the specified device included in the block device mapping of the AMI.
* `virtual_name` - Virtual device name (for instance stores).
* `creation_date` - Date and time the image was created.
Expand Down Expand Up @@ -146,4 +146,4 @@ interpolation.

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

<!-- cache-key: cdktf-0.20.8 input-20e01b0a74f9ac0f7e51fa71d8bb9b456d55fab280e87e7630b32a84f2e95273 -->
<!-- cache-key: cdktf-0.20.8 input-a62b396dede0b1f299cc13f1e83c22aa9abe5fd44d9d3f1c9ddaa82dd03096cd -->
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ class MyConvertedCode(TerraformStack):
ApiGatewayDomainNameAccessAssociation(self, "example",
access_association_source=Token.as_string(aws_vpc_endpoint_example.id),
access_association_source_type="VPCE",
domain_name_arn=Token.as_string(aws_api_gateway_domain_name_example.domain_name_arn)
domain_name_arn=Token.as_string(aws_api_gateway_domain_name_example.arn)
)
```

Expand Down Expand Up @@ -75,4 +75,4 @@ Using `terraform import`, import API Gateway domain name acces associations as u
% terraform import aws_api_gateway_domain_name_access_association.example arn:aws:apigateway:us-west-2:123456789012:/domainnameaccessassociations/domainname/12qmzgp2.9m7ilski.test+hykg7a12e7/vpcesource/vpce-05de3f8f82740a748
```

<!-- cache-key: cdktf-0.20.8 input-fea7ddfd619aab0059f4600448771ebafb7f28b43853f645957f1c276042568d -->
<!-- cache-key: cdktf-0.20.8 input-ac5fcb980ef755047bbbcac35ac93723049a96cffecd83228aa26089ab8a0a60 -->
24 changes: 14 additions & 10 deletions website/docs/cdktf/python/r/backup_region_settings.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -28,25 +28,29 @@ class MyConvertedCode(TerraformStack):
super().__init__(scope, name)
BackupRegionSettings(self, "test",
resource_type_management_preference={
"DynamoDB": True,
"EFS": True
"CloudFormation": True,
"DSQL": True,
"DynamoDB": False,
"EFS": False
},
resource_type_opt_in_preference={
"Aurora": True,
"CloudFormation": True,
"DSQL": True,
"DocumentDB": True,
"DynamoDB": True,
"EBS": True,
"EC2": True,
"EFS": True,
"FSx": True,
"Neptune": True,
"RDS": True,
"RDS": False,
"Redshift": True,
"S3": True,
"SAP HANA on Amazon EC2": True,
"Storage Gateway": True,
"VirtualMachine": True
"Redshift Serverless": False,
"S3": False,
"SAP HANA on Amazon EC2": False,
"Storage Gateway": False,
"VirtualMachine": False
}
)
```
Expand All @@ -55,8 +59,8 @@ class MyConvertedCode(TerraformStack):

This resource supports the following arguments:

* `resource_type_opt_in_preference` - (Required) A map of services along with the opt-in preferences for the Region.
* `resource_type_management_preference` - (Optional) A map of services along with the management preferences for the Region. For more information, see the [AWS Documentation](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_UpdateRegionSettings.html#API_UpdateRegionSettings_RequestSyntax).
* `resource_type_opt_in_preference` - (Required) A map of service names to their opt-in preferences for the Region. See [AWS Documentation on which services support backup](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html).
* `resource_type_management_preference` - (Optional) A map of service names to their full management preferences for the Region. For more information, see the AWS Documentation on [what full management is](https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#full-management) and [which services support full management](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource).

## Attribute Reference

Expand Down Expand Up @@ -89,4 +93,4 @@ Using `terraform import`, import Backup Region Settings using the `region`. For
% terraform import aws_backup_region_settings.test us-west-2
```

<!-- cache-key: cdktf-0.20.8 input-d3c58f003bf7507368740011ee4226900165137ccde5e31635696cd6e2e7cb4e -->
<!-- cache-key: cdktf-0.20.8 input-8521acb0bfdc2f50c96bd82f96cd9b79f99c74e57d8af034ed0e8ba8b9aea094 -->
3 changes: 2 additions & 1 deletion website/docs/cdktf/python/r/ecs_service.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,7 @@ The `managed_ebs_volume` configuration block supports the following:
* `size_in_gb` - (Optional) Size of the volume in GiB. You must specify either a `size_in_gb` or a `snapshot_id`. You can optionally specify a volume size greater than or equal to the snapshot size.
* `snapshot_id` - (Optional) Snapshot that Amazon ECS uses to create the volume. You must specify either a `size_in_gb` or a `snapshot_id`.
* `throughput` - (Optional) Throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s.
* `volume_initialization_rate` - (Optional) Volume Initialization Rate in MiB/s. You must also specify a `snapshot_id`.
* `volume_type` - (Optional) Volume type.
* `tag_specifications` - (Optional) The tags to apply to the volume. [See below](#tag_specifications).

Expand Down Expand Up @@ -436,4 +437,4 @@ Using `terraform import`, import ECS services using the `name` together with ecs
% terraform import aws_ecs_service.imported cluster-name/service-name
```

<!-- cache-key: cdktf-0.20.8 input-2bcd990d1489113643cf2af1249276f0f9e683ffcb02656bfaaff9d5e3d457af -->
<!-- cache-key: cdktf-0.20.8 input-8a3f7df10a6caa0315ce7d31bc09f589d96c19567871829b6f4242fcee7b6fce -->
Original file line number Diff line number Diff line change
Expand Up @@ -537,4 +537,4 @@ Using `terraform import`, import Launch Templates using the `id`. For example:
% terraform import aws_launch_template.web lt-12345678
```

<!-- cache-key: cdktf-0.20.8 input-2013a21ae1f3cfd85ce5b7ee3423d5d1a9fa481ce7b46946a2cb5e72d129ea9f -->
<!-- cache-key: cdktf-0.20.8 input-f96a6df42d4adf0fb13f42a075e9a959af313470da2120128823b0ed62073b56 -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
---
subcategory: "User Notifications"
layout: "aws"
page_title: "AWS: aws_notifications_channel_association"
description: |-
Terraform resource for managing an AWS User Notifications Channel Association.
---

<!-- Please do not edit this file, it is generated. -->
# Resource: aws_notifications_channel_association

Terraform resource for managing an AWS User Notifications Channel Association. This resource associates a channel (such as an email contact) with a notification configuration.

## 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 Token, TerraformStack
#
# Provider bindings are generated by running `cdktf get`.
# See https://cdk.tf/provider-generation for more details.
#
from imports.aws.notifications_channel_association import NotificationsChannelAssociation
from imports.aws.notifications_notification_configuration import NotificationsNotificationConfiguration
from imports.aws.notificationscontacts_email_contact import NotificationscontactsEmailContact
class MyConvertedCode(TerraformStack):
def __init__(self, scope, name):
super().__init__(scope, name)
example = NotificationsNotificationConfiguration(self, "example",
description="Example notification configuration",
name="example-notification-config"
)
aws_notificationscontacts_email_contact_example =
NotificationscontactsEmailContact(self, "example_1",
email_address="[email protected]",
name="example-contact"
)
# This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.
aws_notificationscontacts_email_contact_example.override_logical_id("example")
aws_notifications_channel_association_example =
NotificationsChannelAssociation(self, "example_2",
arn=Token.as_string(aws_notificationscontacts_email_contact_example.arn),
notification_configuration_arn=example.arn
)
# This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.
aws_notifications_channel_association_example.override_logical_id("example")
```

## Argument Reference

The following arguments are required:

* `arn` - (Required) ARN of the channel to associate with the notification configuration. This can be an email contact ARN.
* `notification_configuration_arn` - (Required) ARN of the notification configuration to associate the channel with.

## Attribute Reference

This resource exports no additional attributes.

## Import

In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import User Notifications Channel Association using the `notification_configuration_arn,channel_arn` format. For example:

```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.notifications_channel_association import NotificationsChannelAssociation
class MyConvertedCode(TerraformStack):
def __init__(self, scope, name):
super().__init__(scope, name)
NotificationsChannelAssociation.generate_config_for_import(self, "example", "arn:aws:notifications:us-west-2:123456789012:configuration:example-notification-config,arn:aws:notificationscontacts:us-west-2:123456789012:emailcontact:example-contact")
```

Using `terraform import`, import User Notifications Channel Association using the `notification_configuration_arn,channel_arn` format. For example:

```console
% terraform import aws_notifications_channel_association.example arn:aws:notifications:us-west-2:123456789012:configuration:example-notification-config,arn:aws:notificationscontacts:us-west-2:123456789012:emailcontact:example-contact
```

<!-- cache-key: cdktf-0.20.8 input-f597f71466f74907785d0100aa23fcce79013fd535741b6197f004b6e1db23a8 -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
---
subcategory: "User Notifications"
layout: "aws"
page_title: "AWS: aws_notifications_event_rule"
description: |-
Terraform resource for managing an AWS User Notifications Event Rule.
---

<!-- Please do not edit this file, it is generated. -->
# Resource: aws_notifications_event_rule

Terraform resource for managing an AWS User Notifications Event Rule.

## 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 Fn, Token, TerraformStack
#
# Provider bindings are generated by running `cdktf get`.
# See https://cdk.tf/provider-generation for more details.
#
from imports.aws.notifications_event_rule import NotificationsEventRule
from imports.aws.notifications_notification_configuration import NotificationsNotificationConfiguration
class MyConvertedCode(TerraformStack):
def __init__(self, scope, name):
super().__init__(scope, name)
example = NotificationsNotificationConfiguration(self, "example",
description="example configuration",
name="example"
)
aws_notifications_event_rule_example = NotificationsEventRule(self, "example_1",
event_pattern=Token.as_string(
Fn.jsonencode({
"detail": {
"state": {
"value": ["ALARM"]
}
}
})),
event_type="CloudWatch Alarm State Change",
notification_configuration_arn=example.arn,
regions=["us-east-1", "us-west-2"],
source="aws.cloudwatch"
)
# This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.
aws_notifications_event_rule_example.override_logical_id("example")
```

## Argument Reference

The following arguments are required:

* `event_type` - (Required) Type of event to match. Must be between 1 and 128 characters, and match the pattern `([a-zA-Z0-9 \-\(\)])+`.
* `notification_configuration_arn` - (Required) ARN of the notification configuration to associate with this event rule. Must match the pattern `arn:aws:notifications::[0-9]{12}:configuration/[a-z0-9]{27}`.
* `regions` - (Required) Set of AWS regions where the event rule will be applied. Each region must be between 2 and 25 characters, and match the pattern `([a-z]{1,2})-([a-z]{1,15}-)+([0-9])`.
* `source` - (Required) Source of the event. Must be between 1 and 36 characters, and match the pattern `aws.([a-z0-9\-])+`.

The following arguments are optional:

* `event_pattern` - (Optional) JSON string defining the event pattern to match. Maximum length is 4096 characters.
* `timeouts` - (Optional) Configuration block specifying how long to wait for the event rule to be created, updated, or deleted.

## Attribute Reference

This resource exports the following attributes in addition to the arguments above:

* `arn` - ARN of the Event Rule.

## Import

In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import User Notifications Event Rule using the `arn`. For example:

```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.notifications_event_rule import NotificationsEventRule
class MyConvertedCode(TerraformStack):
def __init__(self, scope, name):
super().__init__(scope, name)
NotificationsEventRule.generate_config_for_import(self, "example", "arn:aws:notifications::123456789012:configuration/abc123def456ghi789jkl012mno345/rule/abc123def456ghi789jkl012mno345")
```

Using `terraform import`, import User Notifications Event Rule using the `arn`. For example:

```console
% terraform import aws_notifications_event_rule.example arn:aws:notifications::123456789012:configuration/abc123def456ghi789jkl012mno345/rule/abc123def456ghi789jkl012mno345
```

<!-- cache-key: cdktf-0.20.8 input-65c919033926d3754a2ad734c69d9befe1039510f9606ec586be4c7b3922edbe -->
Loading
Loading